diff --git a/PureCloudPlatformClientV2.podspec b/PureCloudPlatformClientV2.podspec index d1eb23c6e..8ff90af00 100644 --- a/PureCloudPlatformClientV2.podspec +++ b/PureCloudPlatformClientV2.podspec @@ -4,8 +4,8 @@ Pod::Spec.new do |s| s.ios.deployment_target = '12.0' s.osx.deployment_target = '12.0' s.swift_version = '5.0' - s.version = '157.0.0' - s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '157.0.0' } + s.version = '158.0.0' + s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '158.0.0' } s.authors = 'Genesys Developer Evangelists' s.social_media_url = 'https://twitter.com/PureCloud_Dev' #s.docset_url = 'https://developer.mypurecloud.com/api/rest/client-libraries/ios/' diff --git a/README.md b/README.md index 941e85b16..855ec12dc 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ The iOS SDK is compatible with Swift 5 and does not require any external dependencies. Documentation can be found at https://mypurecloud.github.io/platform-client-sdk-ios/. -Documentation version PureCloudPlatformClientV2@157.0.0 +Documentation version PureCloudPlatformClientV2@158.0.0 ## Install using CocoaPods @@ -12,7 +12,7 @@ This package's source is on github at https://github.com/MyPureCloud/platform-cl Reference the SDK's pod in your project's Podfile: ``` -pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '157.0.0' +pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '158.0.0' ``` Then install your project's dependencies: diff --git a/build/.openapi-generator/FILES b/build/.openapi-generator/FILES index 80ea86654..be8346c2a 100644 --- a/build/.openapi-generator/FILES +++ b/build/.openapi-generator/FILES @@ -787,6 +787,16 @@ docs/ContactColumnTimeZone.md docs/ContactColumnToDataActionFieldMapping.md docs/ContactDetailEventTopicContactUpdateEvent.md docs/ContactIdentifier.md +docs/ContactIdentifierListing.md +docs/ContactImportField.md +docs/ContactImportJobEntityListing.md +docs/ContactImportJobMetadata.md +docs/ContactImportJobRequest.md +docs/ContactImportJobResponse.md +docs/ContactImportJobStatusUpdateRequest.md +docs/ContactImportJobStatusUpdateResponse.md +docs/ContactImportSettings.md +docs/ContactImportSettingsEntityListing.md docs/ContactList.md docs/ContactListDivisionView.md docs/ContactListDivisionViewListing.md @@ -959,6 +969,8 @@ docs/ConversationContentButtonResponse.md docs/ConversationContentCard.md docs/ConversationContentCardAction.md docs/ConversationContentCarousel.md +docs/ConversationContentDatePicker.md +docs/ConversationContentDatePickerAvailableTime.md docs/ConversationContentLocation.md docs/ConversationContentNotificationTemplate.md docs/ConversationContentQuickReply.md @@ -1318,6 +1330,8 @@ docs/DataActionContactColumnFieldMapping.md docs/DataAvailabilityResponse.md docs/DataExtensionsAPI.json docs/DataExtensionsAPI.md +docs/DataPrivacyAPI.json +docs/DataPrivacyAPI.md docs/DataSchema.md docs/DataSchemaListing.md docs/DataTable.md @@ -2484,6 +2498,7 @@ docs/KnowledgeImportJobRequest.md docs/KnowledgeImportJobResponse.md docs/KnowledgeImportJobSettings.md docs/KnowledgeImportJobStatistics.md +docs/KnowledgeIntegrationDefaultSettings.md docs/KnowledgeIntegrationFilter.md docs/KnowledgeIntegrationFilterValue.md docs/KnowledgeIntegrationOptionsResponse.md @@ -2697,6 +2712,10 @@ docs/Manager.md docs/MarkContactAddressUncontactableActionSettings.md docs/MarkContactUncontactableActionSettings.md docs/Markdown.md +docs/MaskingRule.md +docs/MaskingRuleListing.md +docs/MaskingRuleValidateRequest.md +docs/MaskingRuleValidateResponse.md docs/MatchCriteria.md docs/MatchCriteriaTestResult.md docs/MatchShiftTradeRequest.md @@ -3091,6 +3110,10 @@ docs/PerformanceProfile.md docs/PermissionCollectionEntityListing.md docs/PermissionDetails.md docs/Permissions.md +docs/PersistentConnectionChangeTopicErrorInfo.md +docs/PersistentConnectionChangeTopicErrorInfoDetails.md +docs/PersistentConnectionChangeTopicErrorLocation.md +docs/PersistentConnectionChangeTopicPersistentConnectionChangeEvent.md docs/Phone.md docs/PhoneBase.md docs/PhoneBaseEntityListing.md @@ -5002,6 +5025,7 @@ docs/deleteConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt docs/deleteConversationsMessagingSetting-example.txt docs/deleteConversationsMessagingSettingsDefault-example.txt docs/deleteConversationsMessagingSupportedcontentSupportedContentId-example.txt +docs/deleteDataprivacyMaskingrule-example.txt docs/deleteDiagnosticsLogcaptureBrowserUser-example.txt docs/deleteEmployeeengagementCelebration-example.txt docs/deleteEmployeeperformanceExternalmetricsDefinition-example.txt @@ -5010,6 +5034,7 @@ docs/deleteExternalcontactsContactNote-example.txt docs/deleteExternalcontactsContactsSchema-example.txt docs/deleteExternalcontactsExternalsource-example.txt docs/deleteExternalcontactsImportCsvSetting-example.txt +docs/deleteExternalcontactsImportSetting-example.txt docs/deleteExternalcontactsOrganization-example.txt docs/deleteExternalcontactsOrganizationNote-example.txt docs/deleteExternalcontactsOrganizationTrustor-example.txt @@ -5464,6 +5489,8 @@ docs/getConversationsVideoParticipantCommunicationWrapup-example.txt docs/getDataextensionsCoretype-example.txt docs/getDataextensionsCoretypes-example.txt docs/getDataextensionsLimits-example.txt +docs/getDataprivacyMaskingrule-example.txt +docs/getDataprivacyMaskingrules-example.txt docs/getDate-example.txt docs/getDiagnosticsLogcaptureBrowserEntriesDownloadJob-example.txt docs/getDiagnosticsLogcaptureBrowserUser-example.txt @@ -5495,6 +5522,10 @@ docs/getExternalcontactsImportCsvSetting-example.txt docs/getExternalcontactsImportCsvSettings-example.txt docs/getExternalcontactsImportCsvUploadDetails-example.txt docs/getExternalcontactsImportCsvUploadPreview-example.txt +docs/getExternalcontactsImportJob-example.txt +docs/getExternalcontactsImportJobs-example.txt +docs/getExternalcontactsImportSetting-example.txt +docs/getExternalcontactsImportSettings-example.txt docs/getExternalcontactsOrganization-example.txt docs/getExternalcontactsOrganizationContacts-example.txt docs/getExternalcontactsOrganizationNote-example.txt @@ -6476,6 +6507,7 @@ docs/patchConversationsMessagingIntegrationsWhatsappIntegrationId-example.txt docs/patchConversationsMessagingSetting-example.txt docs/patchConversationsMessagingSupportedcontentSupportedContentId-example.txt docs/patchConversationsSettings-example.txt +docs/patchDataprivacyMaskingrule-example.txt docs/patchEmailsSettings-example.txt docs/patchEmailsSettings-example.txt docs/patchEmployeeengagementCelebration-example.txt @@ -6796,6 +6828,8 @@ docs/postConversationsParticipantsAttributesSearch-example.txt docs/postConversationsScreenshareParticipantCommunicationWrapup-example.txt docs/postConversationsSocialParticipantCommunicationWrapup-example.txt docs/postConversationsVideoParticipantCommunicationWrapup-example.txt +docs/postDataprivacyMaskingrules-example.txt +docs/postDataprivacyMaskingrulesValidate-example.txt docs/postDiagnosticsLogcaptureBrowserEntriesDownloadJobs-example.txt docs/postDiagnosticsLogcaptureBrowserEntriesQuery-example.txt docs/postDiagnosticsLogcaptureBrowserUser-example.txt @@ -6833,6 +6867,8 @@ docs/postExternalcontactsIdentifierlookup-example.txt docs/postExternalcontactsImportCsvJobs-example.txt docs/postExternalcontactsImportCsvSettings-example.txt docs/postExternalcontactsImportCsvUploads-example.txt +docs/postExternalcontactsImportJobs-example.txt +docs/postExternalcontactsImportSettings-example.txt docs/postExternalcontactsMergeContacts-example.txt docs/postExternalcontactsOrganizationNotes-example.txt docs/postExternalcontactsOrganizations-example.txt @@ -7324,6 +7360,8 @@ docs/putExternalcontactsContactsSchema-example.txt docs/putExternalcontactsConversation-example.txt docs/putExternalcontactsExternalsource-example.txt docs/putExternalcontactsImportCsvSetting-example.txt +docs/putExternalcontactsImportJob-example.txt +docs/putExternalcontactsImportSetting-example.txt docs/putExternalcontactsOrganization-example.txt docs/putExternalcontactsOrganizationNote-example.txt docs/putExternalcontactsOrganizationTrustorTrustorId-example.txt @@ -7523,6 +7561,7 @@ src/APIs/CoachingAPI.swift src/APIs/ContentManagementAPI.swift src/APIs/ConversationsAPI.swift src/APIs/DataExtensionsAPI.swift +src/APIs/DataPrivacyAPI.swift src/APIs/DownloadsAPI.swift src/APIs/EmailsAPI.swift src/APIs/EmployeeEngagementAPI.swift @@ -8349,6 +8388,16 @@ src/Models/ContactColumnTimeZone.swift src/Models/ContactColumnToDataActionFieldMapping.swift src/Models/ContactDetailEventTopicContactUpdateEvent.swift src/Models/ContactIdentifier.swift +src/Models/ContactIdentifierListing.swift +src/Models/ContactImportField.swift +src/Models/ContactImportJobEntityListing.swift +src/Models/ContactImportJobMetadata.swift +src/Models/ContactImportJobRequest.swift +src/Models/ContactImportJobResponse.swift +src/Models/ContactImportJobStatusUpdateRequest.swift +src/Models/ContactImportJobStatusUpdateResponse.swift +src/Models/ContactImportSettings.swift +src/Models/ContactImportSettingsEntityListing.swift src/Models/ContactList.swift src/Models/ContactListDivisionView.swift src/Models/ContactListDivisionViewListing.swift @@ -8519,6 +8568,8 @@ src/Models/ConversationContentButtonResponse.swift src/Models/ConversationContentCard.swift src/Models/ConversationContentCardAction.swift src/Models/ConversationContentCarousel.swift +src/Models/ConversationContentDatePicker.swift +src/Models/ConversationContentDatePickerAvailableTime.swift src/Models/ConversationContentLocation.swift src/Models/ConversationContentNotificationTemplate.swift src/Models/ConversationContentQuickReply.swift @@ -10006,6 +10057,7 @@ src/Models/KnowledgeImportJobRequest.swift src/Models/KnowledgeImportJobResponse.swift src/Models/KnowledgeImportJobSettings.swift src/Models/KnowledgeImportJobStatistics.swift +src/Models/KnowledgeIntegrationDefaultSettings.swift src/Models/KnowledgeIntegrationFilter.swift src/Models/KnowledgeIntegrationFilterValue.swift src/Models/KnowledgeIntegrationOptionsResponse.swift @@ -10207,6 +10259,10 @@ src/Models/Manager.swift src/Models/MarkContactAddressUncontactableActionSettings.swift src/Models/MarkContactUncontactableActionSettings.swift src/Models/Markdown.swift +src/Models/MaskingRule.swift +src/Models/MaskingRuleListing.swift +src/Models/MaskingRuleValidateRequest.swift +src/Models/MaskingRuleValidateResponse.swift src/Models/MatchCriteria.swift src/Models/MatchCriteriaTestResult.swift src/Models/MatchShiftTradeRequest.swift @@ -10586,6 +10642,10 @@ src/Models/PerformanceProfile.swift src/Models/PermissionCollectionEntityListing.swift src/Models/PermissionDetails.swift src/Models/Permissions.swift +src/Models/PersistentConnectionChangeTopicErrorInfo.swift +src/Models/PersistentConnectionChangeTopicErrorInfoDetails.swift +src/Models/PersistentConnectionChangeTopicErrorLocation.swift +src/Models/PersistentConnectionChangeTopicPersistentConnectionChangeEvent.swift src/Models/Phone.swift src/Models/PhoneBase.swift src/Models/PhoneBaseEntityListing.swift diff --git a/build/APIData.json b/build/APIData.json index 2871ede98..862f9d937 100644 --- a/build/APIData.json +++ b/build/APIData.json @@ -12276,6 +12276,87 @@ "return": "SchemaQuantityLimits", "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get quantitative limits on schemas\nGetDataextensionsLimitsRequest.getDataextensionsLimits() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDataextensionsLimitsRequest.getDataextensionsLimits was successful\")\n dump(response)\n }\n}" }, + "deletedataprivacymaskingrule": { + "operationId": "deletedataprivacymaskingrule", + "functionName": "deleteDataprivacyMaskingrule", + "signature": "deleteDataprivacyMaskingrule(ruleId)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + } + ], + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // ruleId\n\n// Delete a masking rule.\nDeleteDataprivacyMaskingruleRequest.deleteDataprivacyMaskingrule(ruleId: ruleId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteDataprivacyMaskingruleRequest.deleteDataprivacyMaskingrule was successful\")\n }\n}" + }, + "getdataprivacymaskingrule": { + "operationId": "getdataprivacymaskingrule", + "functionName": "getDataprivacyMaskingrule", + "signature": "getDataprivacyMaskingrule(ruleId)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + } + ], + "return": "MaskingRule", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // ruleId\n\n// Fetch details about a masking rule.\nGetDataprivacyMaskingruleRequest.getDataprivacyMaskingrule(ruleId: ruleId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDataprivacyMaskingruleRequest.getDataprivacyMaskingrule was successful\")\n dump(response)\n }\n}" + }, + "getdataprivacymaskingrules": { + "operationId": "getdataprivacymaskingrules", + "functionName": "getDataprivacyMaskingrules", + "signature": "getDataprivacyMaskingrules()", + "return": "MaskingRuleListing", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Retrieve the list of masking rules.\nGetDataprivacyMaskingrulesRequest.getDataprivacyMaskingrules() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetDataprivacyMaskingrulesRequest.getDataprivacyMaskingrules was successful\")\n dump(response)\n }\n}" + }, + "patchdataprivacymaskingrule": { + "operationId": "patchdataprivacymaskingrule", + "functionName": "patchDataprivacyMaskingrule", + "signature": "patchDataprivacyMaskingrule(ruleId, body)", + "parameters": [ + { + "name": "ruleId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "MaskingRule", + "required": "false" + } + ], + "return": "MaskingRule", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet ruleId: String = \"\" // ruleId\nlet body: MaskingRule = new MaskingRule(...) // \n\n// Update information about a masking rule.\nPatchDataprivacyMaskingruleRequest.patchDataprivacyMaskingrule(ruleId: ruleId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PatchDataprivacyMaskingruleRequest.patchDataprivacyMaskingrule was successful\")\n dump(response)\n }\n}" + }, + "postdataprivacymaskingrules": { + "operationId": "postdataprivacymaskingrules", + "functionName": "postDataprivacyMaskingrules", + "signature": "postDataprivacyMaskingrules(body)", + "parameters": [ + { + "name": "body", + "type": "MaskingRule", + "required": "true" + } + ], + "return": "MaskingRule", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MaskingRule = new MaskingRule(...) // Details for creating masking rule resource\n\n// Create a new masking rule resource.\nPostDataprivacyMaskingrulesRequest.postDataprivacyMaskingrules(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostDataprivacyMaskingrulesRequest.postDataprivacyMaskingrules was successful\")\n dump(response)\n }\n}" + }, + "postdataprivacymaskingrulesvalidate": { + "operationId": "postdataprivacymaskingrulesvalidate", + "functionName": "postDataprivacyMaskingrulesValidate", + "signature": "postDataprivacyMaskingrulesValidate(body)", + "parameters": [ + { + "name": "body", + "type": "MaskingRuleValidateRequest", + "required": "true" + } + ], + "return": "MaskingRuleValidateResponse", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: MaskingRuleValidateRequest = new MaskingRuleValidateRequest(...) // Text to be masked\n\n// Validate masking before creating.\nPostDataprivacyMaskingrulesValidateRequest.postDataprivacyMaskingrulesValidate(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostDataprivacyMaskingrulesValidateRequest.postDataprivacyMaskingrulesValidate was successful\")\n dump(response)\n }\n}" + }, "getdownload": { "operationId": "getdownload", "functionName": "getDownload", @@ -12519,6 +12600,19 @@ ], "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet settingsId: String = \"\" // Settings id\n\n// Delete settings for CSV import\nDeleteExternalcontactsImportCsvSettingRequest.deleteExternalcontactsImportCsvSetting(settingsId: settingsId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteExternalcontactsImportCsvSettingRequest.deleteExternalcontactsImportCsvSetting was successful\")\n }\n}" }, + "deleteexternalcontactsimportsetting": { + "operationId": "deleteexternalcontactsimportsetting", + "functionName": "deleteExternalcontactsImportSetting", + "signature": "deleteExternalcontactsImportSetting(settingsId)", + "parameters": [ + { + "name": "settingsId", + "type": "String", + "required": "true" + } + ], + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet settingsId: String = \"\" // Settings id\n\n// Delete Settings\nDeleteExternalcontactsImportSettingRequest.deleteExternalcontactsImportSetting(settingsId: settingsId) { (error) in\n if let error = error {\n dump(error)\n } else {\n print(\"DeleteExternalcontactsImportSettingRequest.deleteExternalcontactsImportSetting was successful\")\n }\n}" + }, "deleteexternalcontactsorganization": { "operationId": "deleteexternalcontactsorganization", "functionName": "deleteExternalcontactsOrganization", @@ -12609,7 +12703,7 @@ "required": "true" } ], - "return": "EntityListing", + "return": "ContactIdentifierListing", "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet contactId: String = \"\" // ExternalContact ID\n\n// List the identifiers for a contact\nGetExternalcontactsContactIdentifiersRequest.getExternalcontactsContactIdentifiers(contactId: contactId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsContactIdentifiersRequest.getExternalcontactsContactIdentifiers was successful\")\n dump(response)\n }\n}" }, "getexternalcontactscontactjourneysessions": { @@ -12915,6 +13009,92 @@ "return": "CsvUploadPreviewResponse", "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet uploadId: String = \"\" // Upload id\n\n// Get preview for CSV upload\nGetExternalcontactsImportCsvUploadPreviewRequest.getExternalcontactsImportCsvUploadPreview(uploadId: uploadId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsImportCsvUploadPreviewRequest.getExternalcontactsImportCsvUploadPreview was successful\")\n dump(response)\n }\n}" }, + "getexternalcontactsimportjob": { + "operationId": "getexternalcontactsimportjob", + "functionName": "getExternalcontactsImportJob", + "signature": "getExternalcontactsImportJob(jobId)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + } + ], + "return": "ContactImportJobResponse", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // Job id\n\n// Get job based on id\nGetExternalcontactsImportJobRequest.getExternalcontactsImportJob(jobId: jobId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsImportJobRequest.getExternalcontactsImportJob was successful\")\n dump(response)\n }\n}" + }, + "getexternalcontactsimportjobs": { + "operationId": "getexternalcontactsimportjobs", + "functionName": "getExternalcontactsImportJobs", + "signature": "getExternalcontactsImportJobs(after, pageSize, sortOrder, jobStatus)", + "parameters": [ + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "jobStatus", + "type": "String", + "required": "false" + } + ], + "return": "ContactImportJobEntityListing", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 100.\nlet sortOrder: GetExternalcontactsImportJobsRequest.SortOrder_getExternalcontactsImportJobs = GetExternalcontactsImportJobsRequest.SortOrder_getExternalcontactsImportJobs.enummember // Direction of sorting.\nlet jobStatus: GetExternalcontactsImportJobsRequest.JobStatus_getExternalcontactsImportJobs = GetExternalcontactsImportJobsRequest.JobStatus_getExternalcontactsImportJobs.enummember // Search term to filter by jobStatus\n\n// List jobs for organization\nGetExternalcontactsImportJobsRequest.getExternalcontactsImportJobs(after: after, pageSize: pageSize, sortOrder: sortOrder, jobStatus: jobStatus) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsImportJobsRequest.getExternalcontactsImportJobs was successful\")\n dump(response)\n }\n}" + }, + "getexternalcontactsimportsetting": { + "operationId": "getexternalcontactsimportsetting", + "functionName": "getExternalcontactsImportSetting", + "signature": "getExternalcontactsImportSetting(settingsId)", + "parameters": [ + { + "name": "settingsId", + "type": "String", + "required": "true" + } + ], + "return": "ContactImportSettings", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet settingsId: String = \"\" // Settings id\n\n// Get setting based on id\nGetExternalcontactsImportSettingRequest.getExternalcontactsImportSetting(settingsId: settingsId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsImportSettingRequest.getExternalcontactsImportSetting was successful\")\n dump(response)\n }\n}" + }, + "getexternalcontactsimportsettings": { + "operationId": "getexternalcontactsimportsettings", + "functionName": "getExternalcontactsImportSettings", + "signature": "getExternalcontactsImportSettings(after, pageSize, sortOrder, name)", + "parameters": [ + { + "name": "after", + "type": "String", + "required": "false" + }, + { + "name": "pageSize", + "type": "String", + "required": "false" + }, + { + "name": "sortOrder", + "type": "String", + "required": "false" + }, + { + "name": "name", + "type": "String", + "required": "false" + } + ], + "return": "ContactImportSettingsEntityListing", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet after: String = \"\" // The cursor that points to the end of the set of entities that has been returned.\nlet pageSize: String = \"\" // Number of entities to return. Maximum of 100.\nlet sortOrder: GetExternalcontactsImportSettingsRequest.SortOrder_getExternalcontactsImportSettings = GetExternalcontactsImportSettingsRequest.SortOrder_getExternalcontactsImportSettings.enummember // Direction of sorting.\nlet name: String = \"\" // Search term to filter by settings name\n\n// List settings for organization\nGetExternalcontactsImportSettingsRequest.getExternalcontactsImportSettings(after: after, pageSize: pageSize, sortOrder: sortOrder, name: name) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetExternalcontactsImportSettingsRequest.getExternalcontactsImportSettings was successful\")\n dump(response)\n }\n}" + }, "getexternalcontactsorganization": { "operationId": "getexternalcontactsorganization", "functionName": "getExternalcontactsOrganization", @@ -13675,6 +13855,34 @@ "return": "CsvUploadResponse", "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: CsvUploadRequest = new CsvUploadRequest(...) // UploadRequest\n\n// Get url for CSV upload\nPostExternalcontactsImportCsvUploadsRequest.postExternalcontactsImportCsvUploads(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsImportCsvUploadsRequest.postExternalcontactsImportCsvUploads was successful\")\n dump(response)\n }\n}" }, + "postexternalcontactsimportjobs": { + "operationId": "postexternalcontactsimportjobs", + "functionName": "postExternalcontactsImportJobs", + "signature": "postExternalcontactsImportJobs(body)", + "parameters": [ + { + "name": "body", + "type": "ContactImportJobRequest", + "required": "true" + } + ], + "return": "ContactImportJobResponse", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ContactImportJobRequest = new ContactImportJobRequest(...) // Job\n\n// Create a new job\nPostExternalcontactsImportJobsRequest.postExternalcontactsImportJobs(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsImportJobsRequest.postExternalcontactsImportJobs was successful\")\n dump(response)\n }\n}" + }, + "postexternalcontactsimportsettings": { + "operationId": "postexternalcontactsimportsettings", + "functionName": "postExternalcontactsImportSettings", + "signature": "postExternalcontactsImportSettings(body)", + "parameters": [ + { + "name": "body", + "type": "ContactImportSettings", + "required": "true" + } + ], + "return": "ContactImportSettings", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet body: ContactImportSettings = new ContactImportSettings(...) // Setting\n\n// Create a new settings\nPostExternalcontactsImportSettingsRequest.postExternalcontactsImportSettings(body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PostExternalcontactsImportSettingsRequest.postExternalcontactsImportSettings was successful\")\n dump(response)\n }\n}" + }, "postexternalcontactsmergecontacts": { "operationId": "postexternalcontactsmergecontacts", "functionName": "postExternalcontactsMergeContacts", @@ -13868,6 +14076,44 @@ "return": "CsvSettings", "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet settingsId: String = \"\" // Settings id\nlet body: CsvSettings = new CsvSettings(...) // Settings\n\n// Update settings for CSV import\nPutExternalcontactsImportCsvSettingRequest.putExternalcontactsImportCsvSetting(settingsId: settingsId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsImportCsvSettingRequest.putExternalcontactsImportCsvSetting was successful\")\n dump(response)\n }\n}" }, + "putexternalcontactsimportjob": { + "operationId": "putexternalcontactsimportjob", + "functionName": "putExternalcontactsImportJob", + "signature": "putExternalcontactsImportJob(jobId, body)", + "parameters": [ + { + "name": "jobId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ContactImportJobStatusUpdateRequest", + "required": "true" + } + ], + "return": "ContactImportJobStatusUpdateResponse", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet jobId: String = \"\" // Job id\nlet body: ContactImportJobStatusUpdateRequest = new ContactImportJobStatusUpdateRequest(...) // Status of the Job's workflow\n\n// Update Job's workflow status\nPutExternalcontactsImportJobRequest.putExternalcontactsImportJob(jobId: jobId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsImportJobRequest.putExternalcontactsImportJob was successful\")\n dump(response)\n }\n}" + }, + "putexternalcontactsimportsetting": { + "operationId": "putexternalcontactsimportsetting", + "functionName": "putExternalcontactsImportSetting", + "signature": "putExternalcontactsImportSetting(settingsId, body)", + "parameters": [ + { + "name": "settingsId", + "type": "String", + "required": "true" + }, + { + "name": "body", + "type": "ContactImportSettings", + "required": "true" + } + ], + "return": "ContactImportSettings", + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet settingsId: String = \"\" // Settings id\nlet body: ContactImportSettings = new ContactImportSettings(...) // Setting\n\n// Update settings\nPutExternalcontactsImportSettingRequest.putExternalcontactsImportSetting(settingsId: settingsId, body: body) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"PutExternalcontactsImportSettingRequest.putExternalcontactsImportSetting was successful\")\n dump(response)\n }\n}" + }, "putexternalcontactsorganization": { "operationId": "putexternalcontactsorganization", "functionName": "putExternalcontactsOrganization", @@ -45999,7 +46245,7 @@ "getworkforcemanagementmanagementunitusertimeoffrequests": { "operationId": "getworkforcemanagementmanagementunitusertimeoffrequests", "functionName": "getWorkforcemanagementManagementunitUserTimeoffrequests", - "signature": "getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId, recentlyReviewed)", + "signature": "getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId)", "parameters": [ { "name": "managementUnitId", @@ -46010,15 +46256,10 @@ "name": "userId", "type": "String", "required": "true" - }, - { - "name": "recentlyReviewed", - "type": "Bool", - "required": "false" } ], "return": "TimeOffRequestList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet userId: String = \"\" // The userId to whom the Time Off Request applies.\nlet recentlyReviewed: Bool = true // Limit results to requests that have been reviewed within the preceding 30 days\n\n// Get a list of time off requests for a given user\nGetWorkforcemanagementManagementunitUserTimeoffrequestsRequest.getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId: managementUnitId, userId: userId, recentlyReviewed: recentlyReviewed) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitUserTimeoffrequestsRequest.getWorkforcemanagementManagementunitUserTimeoffrequests was successful\")\n dump(response)\n }\n}" + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet managementUnitId: String = \"\" // The ID of the management unit, or 'mine' for the management unit of the logged-in user.\nlet userId: String = \"\" // The userId to whom the Time Off Request applies.\n\n// Get a list of time off requests for a given user\nGetWorkforcemanagementManagementunitUserTimeoffrequestsRequest.getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId: managementUnitId, userId: userId) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementManagementunitUserTimeoffrequestsRequest.getWorkforcemanagementManagementunitUserTimeoffrequests was successful\")\n dump(response)\n }\n}" }, "getworkforcemanagementmanagementunitusers": { "operationId": "getworkforcemanagementmanagementunitusers", @@ -46352,16 +46593,9 @@ "getworkforcemanagementtimeoffrequests": { "operationId": "getworkforcemanagementtimeoffrequests", "functionName": "getWorkforcemanagementTimeoffrequests", - "signature": "getWorkforcemanagementTimeoffrequests(recentlyReviewed)", - "parameters": [ - { - "name": "recentlyReviewed", - "type": "Bool", - "required": "false" - } - ], + "signature": "getWorkforcemanagementTimeoffrequests()", "return": "TimeOffRequestList", - "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\nlet recentlyReviewed: Bool = true // Limit results to requests that have been reviewed within the preceding 30 days\n\n// Get a list of time off requests for the current user\nGetWorkforcemanagementTimeoffrequestsRequest.getWorkforcemanagementTimeoffrequests(recentlyReviewed: recentlyReviewed) { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementTimeoffrequestsRequest.getWorkforcemanagementTimeoffrequests was successful\")\n dump(response)\n }\n}" + "example": "import PureCloudPlatformClientV2\n\nPureCloudPlatformClientV2API.basePath = \"\" // expected format: \"https://api.[base path]\"\nPureCloudPlatformClientV2API.accessToken = \"your_access_token\"\n\n\n// Get a list of time off requests for the current user\nGetWorkforcemanagementTimeoffrequestsRequest.getWorkforcemanagementTimeoffrequests() { (response, error) in\n if let error = error {\n dump(error)\n } else if let response = response {\n print(\"GetWorkforcemanagementTimeoffrequestsRequest.getWorkforcemanagementTimeoffrequests was successful\")\n dump(response)\n }\n}" }, "getworkforcemanagementuserworkplanbidranks": { "operationId": "getworkforcemanagementuserworkplanbidranks", diff --git a/build/PureCloudPlatformClientV2.podspec b/build/PureCloudPlatformClientV2.podspec index d1eb23c6e..8ff90af00 100644 --- a/build/PureCloudPlatformClientV2.podspec +++ b/build/PureCloudPlatformClientV2.podspec @@ -4,8 +4,8 @@ Pod::Spec.new do |s| s.ios.deployment_target = '12.0' s.osx.deployment_target = '12.0' s.swift_version = '5.0' - s.version = '157.0.0' - s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '157.0.0' } + s.version = '158.0.0' + s.source = { :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '158.0.0' } s.authors = 'Genesys Developer Evangelists' s.social_media_url = 'https://twitter.com/PureCloud_Dev' #s.docset_url = 'https://developer.mypurecloud.com/api/rest/client-libraries/ios/' diff --git a/build/README.md b/build/README.md index 941e85b16..855ec12dc 100644 --- a/build/README.md +++ b/build/README.md @@ -2,7 +2,7 @@ The iOS SDK is compatible with Swift 5 and does not require any external dependencies. Documentation can be found at https://mypurecloud.github.io/platform-client-sdk-ios/. -Documentation version PureCloudPlatformClientV2@157.0.0 +Documentation version PureCloudPlatformClientV2@158.0.0 ## Install using CocoaPods @@ -12,7 +12,7 @@ This package's source is on github at https://github.com/MyPureCloud/platform-cl Reference the SDK's pod in your project's Podfile: ``` -pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '157.0.0' +pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '158.0.0' ``` Then install your project's dependencies: diff --git a/build/docs/ADFS.md b/build/docs/ADFS.md index b3d3617de..fdb98f0d9 100644 --- a/build/docs/ADFS.md +++ b/build/docs/ADFS.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcceleratorInput.md b/build/docs/AcceleratorInput.md index 40798fe2c..345f20753 100644 --- a/build/docs/AcceleratorInput.md +++ b/build/docs/AcceleratorInput.md @@ -13,4 +13,4 @@ Identity of a CX infrastructure as code accelerator to be run and its inputs -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcceleratorList.md b/build/docs/AcceleratorList.md index a4ef6bd0b..2c9085bd5 100644 --- a/build/docs/AcceleratorList.md +++ b/build/docs/AcceleratorList.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcceleratorMetadata.md b/build/docs/AcceleratorMetadata.md index 8435be881..8f893a6ca 100644 --- a/build/docs/AcceleratorMetadata.md +++ b/build/docs/AcceleratorMetadata.md @@ -18,4 +18,4 @@ Metadata for a CX infrastructure as code accelerator -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcceleratorParameter.md b/build/docs/AcceleratorParameter.md index ab453d145..b967337f0 100644 --- a/build/docs/AcceleratorParameter.md +++ b/build/docs/AcceleratorParameter.md @@ -12,4 +12,4 @@ Input parameter for a CX infrastructure as code accelerator -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcceleratorSpecification.md b/build/docs/AcceleratorSpecification.md index dd8e82429..d5ec83aad 100644 --- a/build/docs/AcceleratorSpecification.md +++ b/build/docs/AcceleratorSpecification.md @@ -23,4 +23,4 @@ Metadata for a CX infrastructure as code accelerator -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcdEndDetailEventTopicAcdEndEvent.md b/build/docs/AcdEndDetailEventTopicAcdEndEvent.md index d31607441..7dcb02313 100644 --- a/build/docs/AcdEndDetailEventTopicAcdEndEvent.md +++ b/build/docs/AcdEndDetailEventTopicAcdEndEvent.md @@ -41,4 +41,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcdStartDetailEventTopicAcdStartEvent.md b/build/docs/AcdStartDetailEventTopicAcdStartEvent.md index 452d9f06c..c6d93f7db 100644 --- a/build/docs/AcdStartDetailEventTopicAcdStartEvent.md +++ b/build/docs/AcdStartDetailEventTopicAcdStartEvent.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AchievedOutcome.md b/build/docs/AchievedOutcome.md index 10cdd0bc4..502648537 100644 --- a/build/docs/AchievedOutcome.md +++ b/build/docs/AchievedOutcome.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcknowledgeScreenRecordingRequest.md b/build/docs/AcknowledgeScreenRecordingRequest.md index b80c0b377..6fc6d28b8 100644 --- a/build/docs/AcknowledgeScreenRecordingRequest.md +++ b/build/docs/AcknowledgeScreenRecordingRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Action.md b/build/docs/Action.md index 1848ea110..2468428ca 100644 --- a/build/docs/Action.md +++ b/build/docs/Action.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionAggregateDataContainer.md b/build/docs/ActionAggregateDataContainer.md index 90c4570ed..e23bb8e65 100644 --- a/build/docs/ActionAggregateDataContainer.md +++ b/build/docs/ActionAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionAggregateQueryClause.md b/build/docs/ActionAggregateQueryClause.md index d298d5103..c34a5392d 100644 --- a/build/docs/ActionAggregateQueryClause.md +++ b/build/docs/ActionAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionAggregateQueryFilter.md b/build/docs/ActionAggregateQueryFilter.md index 2e353d4a3..33c1cafe9 100644 --- a/build/docs/ActionAggregateQueryFilter.md +++ b/build/docs/ActionAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionAggregateQueryPredicate.md b/build/docs/ActionAggregateQueryPredicate.md index f3cb13a8d..c37026b19 100644 --- a/build/docs/ActionAggregateQueryPredicate.md +++ b/build/docs/ActionAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionAggregateQueryResponse.md b/build/docs/ActionAggregateQueryResponse.md index e0909cdc9..cac8cb0a9 100644 --- a/build/docs/ActionAggregateQueryResponse.md +++ b/build/docs/ActionAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionAggregationQuery.md b/build/docs/ActionAggregationQuery.md index d59b90ee2..259525d87 100644 --- a/build/docs/ActionAggregationQuery.md +++ b/build/docs/ActionAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionAggregationView.md b/build/docs/ActionAggregationView.md index 5c7b9cbde..ad5b5956a 100644 --- a/build/docs/ActionAggregationView.md +++ b/build/docs/ActionAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionCertificate.md b/build/docs/ActionCertificate.md index 49a065db9..3514999ed 100644 --- a/build/docs/ActionCertificate.md +++ b/build/docs/ActionCertificate.md @@ -14,4 +14,4 @@ Details for an mTLS certificate -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionCertificateListing.md b/build/docs/ActionCertificateListing.md index dbe4bab3f..a2789bc93 100644 --- a/build/docs/ActionCertificateListing.md +++ b/build/docs/ActionCertificateListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionConfig.md b/build/docs/ActionConfig.md index d04f719a4..85f4103fb 100644 --- a/build/docs/ActionConfig.md +++ b/build/docs/ActionConfig.md @@ -13,4 +13,4 @@ Defines components of the Action Config. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionContract.md b/build/docs/ActionContract.md index 89c369970..a6eba358a 100644 --- a/build/docs/ActionContract.md +++ b/build/docs/ActionContract.md @@ -12,4 +12,4 @@ This resource contains all of the schemas needed to define the inputs and output -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionContractInput.md b/build/docs/ActionContractInput.md index a10e56e86..cc27adbfd 100644 --- a/build/docs/ActionContractInput.md +++ b/build/docs/ActionContractInput.md @@ -12,4 +12,4 @@ Contract definition. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionEntityListing.md b/build/docs/ActionEntityListing.md index 29b7fd680..8409ef5b8 100644 --- a/build/docs/ActionEntityListing.md +++ b/build/docs/ActionEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionEventActionMap.md b/build/docs/ActionEventActionMap.md index 054aa2b7d..4fe1fd2bf 100644 --- a/build/docs/ActionEventActionMap.md +++ b/build/docs/ActionEventActionMap.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionEventRequest.md b/build/docs/ActionEventRequest.md index ddd34c74f..fcb419324 100644 --- a/build/docs/ActionEventRequest.md +++ b/build/docs/ActionEventRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionInput.md b/build/docs/ActionInput.md index ee5d69c14..b12630331 100644 --- a/build/docs/ActionInput.md +++ b/build/docs/ActionInput.md @@ -13,4 +13,4 @@ Input requirements of Action. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMap.md b/build/docs/ActionMap.md index a5bd00cee..a3cd9e21a 100644 --- a/build/docs/ActionMap.md +++ b/build/docs/ActionMap.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMapAction.md b/build/docs/ActionMapAction.md index 8f44ea2bd..b237be489 100644 --- a/build/docs/ActionMapAction.md +++ b/build/docs/ActionMapAction.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMapActionTemplate.md b/build/docs/ActionMapActionTemplate.md index 967114992..77a981982 100644 --- a/build/docs/ActionMapActionTemplate.md +++ b/build/docs/ActionMapActionTemplate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMapEstimateOutcomeCriteria.md b/build/docs/ActionMapEstimateOutcomeCriteria.md index 1a7b1e189..f6fc298b8 100644 --- a/build/docs/ActionMapEstimateOutcomeCriteria.md +++ b/build/docs/ActionMapEstimateOutcomeCriteria.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMapEstimateRequest.md b/build/docs/ActionMapEstimateRequest.md index 838d884b7..f00bd7823 100644 --- a/build/docs/ActionMapEstimateRequest.md +++ b/build/docs/ActionMapEstimateRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMapEstimateResult.md b/build/docs/ActionMapEstimateResult.md index 5cd989d42..1be60b67c 100644 --- a/build/docs/ActionMapEstimateResult.md +++ b/build/docs/ActionMapEstimateResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMapListing.md b/build/docs/ActionMapListing.md index 6942fdf01..0e19c4d16 100644 --- a/build/docs/ActionMapListing.md +++ b/build/docs/ActionMapListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMapScheduleGroup.md b/build/docs/ActionMapScheduleGroup.md index 764a60687..f73afe6e7 100644 --- a/build/docs/ActionMapScheduleGroup.md +++ b/build/docs/ActionMapScheduleGroup.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionMapScheduleGroups.md b/build/docs/ActionMapScheduleGroups.md index d6805717c..30bac58dc 100644 --- a/build/docs/ActionMapScheduleGroups.md +++ b/build/docs/ActionMapScheduleGroups.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionOutput.md b/build/docs/ActionOutput.md index c5ebebb98..ec727ac75 100644 --- a/build/docs/ActionOutput.md +++ b/build/docs/ActionOutput.md @@ -16,4 +16,4 @@ Output definition of Action. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionProperties.md b/build/docs/ActionProperties.md index 896a7e307..f1cd3b4fb 100644 --- a/build/docs/ActionProperties.md +++ b/build/docs/ActionProperties.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionSurvey.md b/build/docs/ActionSurvey.md index ab1c743c2..72f237513 100644 --- a/build/docs/ActionSurvey.md +++ b/build/docs/ActionSurvey.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionTarget.md b/build/docs/ActionTarget.md index 59efc6340..36ad3e7ec 100644 --- a/build/docs/ActionTarget.md +++ b/build/docs/ActionTarget.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionTargetListing.md b/build/docs/ActionTargetListing.md index a4b3abc14..7f8afa567 100644 --- a/build/docs/ActionTargetListing.md +++ b/build/docs/ActionTargetListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionTemplate.md b/build/docs/ActionTemplate.md index d763d2601..a89b91fe0 100644 --- a/build/docs/ActionTemplate.md +++ b/build/docs/ActionTemplate.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActionTemplateListing.md b/build/docs/ActionTemplateListing.md index 840c1b3b7..a45b6fa61 100644 --- a/build/docs/ActionTemplateListing.md +++ b/build/docs/ActionTemplateListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Actions.md b/build/docs/Actions.md index 2333f8b56..6562ac653 100644 --- a/build/docs/Actions.md +++ b/build/docs/Actions.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Activation.md b/build/docs/Activation.md index c338424ca..587a06f82 100644 --- a/build/docs/Activation.md +++ b/build/docs/Activation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActiveAlertCount.md b/build/docs/ActiveAlertCount.md index 3a0da621d..7aa7e6635 100644 --- a/build/docs/ActiveAlertCount.md +++ b/build/docs/ActiveAlertCount.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityCode.md b/build/docs/ActivityCode.md index f833cdd3c..45af03ea7 100644 --- a/build/docs/ActivityCode.md +++ b/build/docs/ActivityCode.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityCodeContainer.md b/build/docs/ActivityCodeContainer.md index c0748ae2a..78f1dd109 100644 --- a/build/docs/ActivityCodeContainer.md +++ b/build/docs/ActivityCodeContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityCodeReference.md b/build/docs/ActivityCodeReference.md index 564c39887..885bc6be1 100644 --- a/build/docs/ActivityCodeReference.md +++ b/build/docs/ActivityCodeReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityCodeSummary.md b/build/docs/ActivityCodeSummary.md index 94550eb32..66adb85f3 100644 --- a/build/docs/ActivityCodeSummary.md +++ b/build/docs/ActivityCodeSummary.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityCodesReference.md b/build/docs/ActivityCodesReference.md index 8dcb0b30c..f395c283e 100644 --- a/build/docs/ActivityCodesReference.md +++ b/build/docs/ActivityCodesReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanAbandonRateImpactOverride.md b/build/docs/ActivityPlanAbandonRateImpactOverride.md index 54a111e8f..6dd4ece70 100644 --- a/build/docs/ActivityPlanAbandonRateImpactOverride.md +++ b/build/docs/ActivityPlanAbandonRateImpactOverride.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanAsaImpactOverride.md b/build/docs/ActivityPlanAsaImpactOverride.md index 91b296eb0..ac1d32029 100644 --- a/build/docs/ActivityPlanAsaImpactOverride.md +++ b/build/docs/ActivityPlanAsaImpactOverride.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanJobException.md b/build/docs/ActivityPlanJobException.md index d742d8d82..a9f2e5904 100644 --- a/build/docs/ActivityPlanJobException.md +++ b/build/docs/ActivityPlanJobException.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanJobListing.md b/build/docs/ActivityPlanJobListing.md index 5090ef69b..302ed5b44 100644 --- a/build/docs/ActivityPlanJobListing.md +++ b/build/docs/ActivityPlanJobListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanJobResponse.md b/build/docs/ActivityPlanJobResponse.md index 3909b582d..570697935 100644 --- a/build/docs/ActivityPlanJobResponse.md +++ b/build/docs/ActivityPlanJobResponse.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanListItem.md b/build/docs/ActivityPlanListItem.md index 21cf80a48..446c6924d 100644 --- a/build/docs/ActivityPlanListItem.md +++ b/build/docs/ActivityPlanListItem.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanListing.md b/build/docs/ActivityPlanListing.md index d2ed27afd..3b0cb3f98 100644 --- a/build/docs/ActivityPlanListing.md +++ b/build/docs/ActivityPlanListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanOccurrenceReference.md b/build/docs/ActivityPlanOccurrenceReference.md index e9c9b1c93..bebe1956a 100644 --- a/build/docs/ActivityPlanOccurrenceReference.md +++ b/build/docs/ActivityPlanOccurrenceReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanReference.md b/build/docs/ActivityPlanReference.md index 611d057a2..ea2862dc6 100644 --- a/build/docs/ActivityPlanReference.md +++ b/build/docs/ActivityPlanReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanResponse.md b/build/docs/ActivityPlanResponse.md index 03ec08ca1..3ed348c69 100644 --- a/build/docs/ActivityPlanResponse.md +++ b/build/docs/ActivityPlanResponse.md @@ -35,4 +35,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanRunJobResponse.md b/build/docs/ActivityPlanRunJobResponse.md index d24b5f275..2fc4dbfba 100644 --- a/build/docs/ActivityPlanRunJobResponse.md +++ b/build/docs/ActivityPlanRunJobResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanServiceGoalImpactOverrides.md b/build/docs/ActivityPlanServiceGoalImpactOverrides.md index b344b265b..6ca4de26d 100644 --- a/build/docs/ActivityPlanServiceGoalImpactOverrides.md +++ b/build/docs/ActivityPlanServiceGoalImpactOverrides.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ActivityPlanServiceLevelImpactOverride.md b/build/docs/ActivityPlanServiceLevelImpactOverride.md index b069a1678..8f5f272b3 100644 --- a/build/docs/ActivityPlanServiceLevelImpactOverride.md +++ b/build/docs/ActivityPlanServiceLevelImpactOverride.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcwDetailEventTopicAfterCallWorkEvent.md b/build/docs/AcwDetailEventTopicAfterCallWorkEvent.md index 49cf4bb1e..10abc8313 100644 --- a/build/docs/AcwDetailEventTopicAfterCallWorkEvent.md +++ b/build/docs/AcwDetailEventTopicAfterCallWorkEvent.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AcwSettings.md b/build/docs/AcwSettings.md index 3d3424df2..e3b1e15da 100644 --- a/build/docs/AcwSettings.md +++ b/build/docs/AcwSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddAdherenceExplanationAdminRequest.md b/build/docs/AddAdherenceExplanationAdminRequest.md index 25c4334b2..32665b368 100644 --- a/build/docs/AddAdherenceExplanationAdminRequest.md +++ b/build/docs/AddAdherenceExplanationAdminRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddAdherenceExplanationAgentRequest.md b/build/docs/AddAdherenceExplanationAgentRequest.md index b91853a63..96b3e8127 100644 --- a/build/docs/AddAdherenceExplanationAgentRequest.md +++ b/build/docs/AddAdherenceExplanationAgentRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddConversationRequest.md b/build/docs/AddConversationRequest.md index 3e5bdeb00..5dee66098 100644 --- a/build/docs/AddConversationRequest.md +++ b/build/docs/AddConversationRequest.md @@ -11,4 +11,4 @@ Update coaching appointment request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddConversationResponse.md b/build/docs/AddConversationResponse.md index bf18e94d8..a3e5483f0 100644 --- a/build/docs/AddConversationResponse.md +++ b/build/docs/AddConversationResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddShiftTradeRequest.md b/build/docs/AddShiftTradeRequest.md index 4fd24bd0c..8f5bddfcf 100644 --- a/build/docs/AddShiftTradeRequest.md +++ b/build/docs/AddShiftTradeRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddWorkPlanRotationAgentRequest.md b/build/docs/AddWorkPlanRotationAgentRequest.md index 6e2b60bef..4a4560ed6 100644 --- a/build/docs/AddWorkPlanRotationAgentRequest.md +++ b/build/docs/AddWorkPlanRotationAgentRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddWorkPlanRotationRequest.md b/build/docs/AddWorkPlanRotationRequest.md index 207cdd998..c988af82a 100644 --- a/build/docs/AddWorkPlanRotationRequest.md +++ b/build/docs/AddWorkPlanRotationRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdditionalLanguagesIntent.md b/build/docs/AdditionalLanguagesIntent.md index 53b44c0cf..93e4e636d 100644 --- a/build/docs/AdditionalLanguagesIntent.md +++ b/build/docs/AdditionalLanguagesIntent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdditionalLanguagesSynonyms.md b/build/docs/AdditionalLanguagesSynonyms.md index 2922cb046..e965ddd21 100644 --- a/build/docs/AdditionalLanguagesSynonyms.md +++ b/build/docs/AdditionalLanguagesSynonyms.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdditionalMessage.md b/build/docs/AdditionalMessage.md index 18ccacd76..366d12c0c 100644 --- a/build/docs/AdditionalMessage.md +++ b/build/docs/AdditionalMessage.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Address.md b/build/docs/Address.md index 448fdc669..7d46e4dea 100644 --- a/build/docs/Address.md +++ b/build/docs/Address.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddressableEntity.md b/build/docs/AddressableEntity.md index 0df67f128..a42c39d9c 100644 --- a/build/docs/AddressableEntity.md +++ b/build/docs/AddressableEntity.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddressableEntityRef.md b/build/docs/AddressableEntityRef.md index 3f2ccac40..165185356 100644 --- a/build/docs/AddressableEntityRef.md +++ b/build/docs/AddressableEntityRef.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AddressableLicenseDefinition.md b/build/docs/AddressableLicenseDefinition.md index 198fe2a47..a0e7ca9b6 100644 --- a/build/docs/AddressableLicenseDefinition.md +++ b/build/docs/AddressableLicenseDefinition.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceExplanationAsyncResponse.md b/build/docs/AdherenceExplanationAsyncResponse.md index 82c94cb0b..f54840964 100644 --- a/build/docs/AdherenceExplanationAsyncResponse.md +++ b/build/docs/AdherenceExplanationAsyncResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceExplanationJob.md b/build/docs/AdherenceExplanationJob.md index bceaa5747..64a987989 100644 --- a/build/docs/AdherenceExplanationJob.md +++ b/build/docs/AdherenceExplanationJob.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceExplanationJobReference.md b/build/docs/AdherenceExplanationJobReference.md index ccc27a37d..6e36eebc9 100644 --- a/build/docs/AdherenceExplanationJobReference.md +++ b/build/docs/AdherenceExplanationJobReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceExplanationListing.md b/build/docs/AdherenceExplanationListing.md index d89f35273..1a64f4f74 100644 --- a/build/docs/AdherenceExplanationListing.md +++ b/build/docs/AdherenceExplanationListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceExplanationListingAgentQueryResponse.md b/build/docs/AdherenceExplanationListingAgentQueryResponse.md index 966718fc0..1d2cfc8b5 100644 --- a/build/docs/AdherenceExplanationListingAgentQueryResponse.md +++ b/build/docs/AdherenceExplanationListingAgentQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceExplanationListingBuQueryResponse.md b/build/docs/AdherenceExplanationListingBuQueryResponse.md index 8b9792e55..ecf83c0a7 100644 --- a/build/docs/AdherenceExplanationListingBuQueryResponse.md +++ b/build/docs/AdherenceExplanationListingBuQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceExplanationNotification.md b/build/docs/AdherenceExplanationNotification.md index 2aed130c2..8f740e322 100644 --- a/build/docs/AdherenceExplanationNotification.md +++ b/build/docs/AdherenceExplanationNotification.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceExplanationResponse.md b/build/docs/AdherenceExplanationResponse.md index c3d051d4c..df19e70bb 100644 --- a/build/docs/AdherenceExplanationResponse.md +++ b/build/docs/AdherenceExplanationResponse.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdherenceSettings.md b/build/docs/AdherenceSettings.md index 8c7645402..676873c40 100644 --- a/build/docs/AdherenceSettings.md +++ b/build/docs/AdherenceSettings.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdhocRecordingTopicConversationData.md b/build/docs/AdhocRecordingTopicConversationData.md index 8021a5063..378f0d89b 100644 --- a/build/docs/AdhocRecordingTopicConversationData.md +++ b/build/docs/AdhocRecordingTopicConversationData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdhocRecordingTopicLockData.md b/build/docs/AdhocRecordingTopicLockData.md index c23a06cc9..f468ab224 100644 --- a/build/docs/AdhocRecordingTopicLockData.md +++ b/build/docs/AdhocRecordingTopicLockData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdhocRecordingTopicRecordingDataV2.md b/build/docs/AdhocRecordingTopicRecordingDataV2.md index f3aaa3ba8..b908d47fd 100644 --- a/build/docs/AdhocRecordingTopicRecordingDataV2.md +++ b/build/docs/AdhocRecordingTopicRecordingDataV2.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdhocRecordingTopicUserData.md b/build/docs/AdhocRecordingTopicUserData.md index 24fb53102..87f3da741 100644 --- a/build/docs/AdhocRecordingTopicUserData.md +++ b/build/docs/AdhocRecordingTopicUserData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdhocRecordingTopicWorkspaceData.md b/build/docs/AdhocRecordingTopicWorkspaceData.md index d4a375339..5b7ae16d1 100644 --- a/build/docs/AdhocRecordingTopicWorkspaceData.md +++ b/build/docs/AdhocRecordingTopicWorkspaceData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Adjacents.md b/build/docs/Adjacents.md index cf178508a..65094cbf5 100644 --- a/build/docs/Adjacents.md +++ b/build/docs/Adjacents.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdjustableLiveSpeakerDetection.md b/build/docs/AdjustableLiveSpeakerDetection.md index 8295188fd..d0e073d7d 100644 --- a/build/docs/AdjustableLiveSpeakerDetection.md +++ b/build/docs/AdjustableLiveSpeakerDetection.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdminAgentWorkPlanBiddingPreference.md b/build/docs/AdminAgentWorkPlanBiddingPreference.md index 3f089f0a0..5d97f77fe 100644 --- a/build/docs/AdminAgentWorkPlanBiddingPreference.md +++ b/build/docs/AdminAgentWorkPlanBiddingPreference.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdminAgentWorkPlanPreferenceResponse.md b/build/docs/AdminAgentWorkPlanPreferenceResponse.md index 90f63a7b3..f0f417311 100644 --- a/build/docs/AdminAgentWorkPlanPreferenceResponse.md +++ b/build/docs/AdminAgentWorkPlanPreferenceResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdminBulkUpdateAlternativeShiftTradeState.md b/build/docs/AdminBulkUpdateAlternativeShiftTradeState.md index 122f456d7..1b0b014f1 100644 --- a/build/docs/AdminBulkUpdateAlternativeShiftTradeState.md +++ b/build/docs/AdminBulkUpdateAlternativeShiftTradeState.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdminBulkUpdateAlternativeShiftTradeStateRequest.md b/build/docs/AdminBulkUpdateAlternativeShiftTradeStateRequest.md index 57ff1d610..5ba41aa44 100644 --- a/build/docs/AdminBulkUpdateAlternativeShiftTradeStateRequest.md +++ b/build/docs/AdminBulkUpdateAlternativeShiftTradeStateRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AdminTimeOffRequestPatch.md b/build/docs/AdminTimeOffRequestPatch.md index 0105427e4..e3e007ae7 100644 --- a/build/docs/AdminTimeOffRequestPatch.md +++ b/build/docs/AdminTimeOffRequestPatch.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AfterCallWork.md b/build/docs/AfterCallWork.md index 49a0d055a..e5079a03d 100644 --- a/build/docs/AfterCallWork.md +++ b/build/docs/AfterCallWork.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AfterCallWorkUpdate.md b/build/docs/AfterCallWorkUpdate.md index 216351836..36376cf49 100644 --- a/build/docs/AfterCallWorkUpdate.md +++ b/build/docs/AfterCallWorkUpdate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Agent.md b/build/docs/Agent.md index 07c89185a..5a853fb23 100644 --- a/build/docs/Agent.md +++ b/build/docs/Agent.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentActivity.md b/build/docs/AgentActivity.md index f8f152346..b195a33bf 100644 --- a/build/docs/AgentActivity.md +++ b/build/docs/AgentActivity.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentActivityChangedTopicAgentActivity.md b/build/docs/AgentActivityChangedTopicAgentActivity.md index 6ecfb1ac3..d5ca07eb8 100644 --- a/build/docs/AgentActivityChangedTopicAgentActivity.md +++ b/build/docs/AgentActivityChangedTopicAgentActivity.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentActivityChangedTopicOrganizationPresence.md b/build/docs/AgentActivityChangedTopicOrganizationPresence.md index 33ab01129..49e40d0d3 100644 --- a/build/docs/AgentActivityChangedTopicOrganizationPresence.md +++ b/build/docs/AgentActivityChangedTopicOrganizationPresence.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentActivityChangedTopicOutOfOffice.md b/build/docs/AgentActivityChangedTopicOutOfOffice.md index 340cc1de9..069b2c9e6 100644 --- a/build/docs/AgentActivityChangedTopicOutOfOffice.md +++ b/build/docs/AgentActivityChangedTopicOutOfOffice.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentActivityChangedTopicPresence.md b/build/docs/AgentActivityChangedTopicPresence.md index b9bf31431..1518c6a06 100644 --- a/build/docs/AgentActivityChangedTopicPresence.md +++ b/build/docs/AgentActivityChangedTopicPresence.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentActivityChangedTopicRoutingStatus.md b/build/docs/AgentActivityChangedTopicRoutingStatus.md index f59c8ee5c..cdad0aa4e 100644 --- a/build/docs/AgentActivityChangedTopicRoutingStatus.md +++ b/build/docs/AgentActivityChangedTopicRoutingStatus.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentActivityEntityListing.md b/build/docs/AgentActivityEntityListing.md index e8c08f0e3..06beab7be 100644 --- a/build/docs/AgentActivityEntityListing.md +++ b/build/docs/AgentActivityEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentAssistantsAPI.md b/build/docs/AgentAssistantsAPI.md index 7af50a200..777dfc1b4 100644 --- a/build/docs/AgentAssistantsAPI.md +++ b/build/docs/AgentAssistantsAPI.md @@ -658,4 +658,4 @@ AgentAssistantsAPI.putAssistantQueue(assistantId: assistantId, queueId: queueId, [**AssistantQueue**](AssistantQueue) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentBidWorkPlanOverrideRequest.md b/build/docs/AgentBidWorkPlanOverrideRequest.md index b571d6421..7375e172d 100644 --- a/build/docs/AgentBidWorkPlanOverrideRequest.md +++ b/build/docs/AgentBidWorkPlanOverrideRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCopilotAPI.md b/build/docs/AgentCopilotAPI.md index d2a00fead..b18397228 100644 --- a/build/docs/AgentCopilotAPI.md +++ b/build/docs/AgentCopilotAPI.md @@ -111,4 +111,4 @@ AgentCopilotAPI.putAssistantCopilot(assistantId: assistantId, body: body) { (res [**Copilot**](Copilot) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCopilotAggregateDataContainer.md b/build/docs/AgentCopilotAggregateDataContainer.md index 57de48d7e..6a1ea9688 100644 --- a/build/docs/AgentCopilotAggregateDataContainer.md +++ b/build/docs/AgentCopilotAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCopilotAggregateQueryClause.md b/build/docs/AgentCopilotAggregateQueryClause.md index 53a8ce6ae..3e9135957 100644 --- a/build/docs/AgentCopilotAggregateQueryClause.md +++ b/build/docs/AgentCopilotAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCopilotAggregateQueryFilter.md b/build/docs/AgentCopilotAggregateQueryFilter.md index 31bf962c7..54602eaf5 100644 --- a/build/docs/AgentCopilotAggregateQueryFilter.md +++ b/build/docs/AgentCopilotAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCopilotAggregateQueryPredicate.md b/build/docs/AgentCopilotAggregateQueryPredicate.md index 1d414f587..d15fe2817 100644 --- a/build/docs/AgentCopilotAggregateQueryPredicate.md +++ b/build/docs/AgentCopilotAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCopilotAggregateQueryResponse.md b/build/docs/AgentCopilotAggregateQueryResponse.md index 1ef5c8454..a3dcdc117 100644 --- a/build/docs/AgentCopilotAggregateQueryResponse.md +++ b/build/docs/AgentCopilotAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCopilotAggregationQuery.md b/build/docs/AgentCopilotAggregationQuery.md index fbf9aeb3c..1e25b89f3 100644 --- a/build/docs/AgentCopilotAggregationQuery.md +++ b/build/docs/AgentCopilotAggregationQuery.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCopilotAggregationView.md b/build/docs/AgentCopilotAggregationView.md index c1381fcf0..dc2b77644 100644 --- a/build/docs/AgentCopilotAggregationView.md +++ b/build/docs/AgentCopilotAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentCountRange.md b/build/docs/AgentCountRange.md index 88cec7d6a..c31b3412b 100644 --- a/build/docs/AgentCountRange.md +++ b/build/docs/AgentCountRange.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentDirectRoutingBackupSettings.md b/build/docs/AgentDirectRoutingBackupSettings.md index 06d101637..2d511a823 100644 --- a/build/docs/AgentDirectRoutingBackupSettings.md +++ b/build/docs/AgentDirectRoutingBackupSettings.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentEvaluatorActivity.md b/build/docs/AgentEvaluatorActivity.md index 7091a4649..cfa183ab2 100644 --- a/build/docs/AgentEvaluatorActivity.md +++ b/build/docs/AgentEvaluatorActivity.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentIntegrationAssociationRequest.md b/build/docs/AgentIntegrationAssociationRequest.md index f035fffbb..3fd786745 100644 --- a/build/docs/AgentIntegrationAssociationRequest.md +++ b/build/docs/AgentIntegrationAssociationRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentIntegrationAssociationResponse.md b/build/docs/AgentIntegrationAssociationResponse.md index 7dcd42204..24028370f 100644 --- a/build/docs/AgentIntegrationAssociationResponse.md +++ b/build/docs/AgentIntegrationAssociationResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentIntegrationsRequest.md b/build/docs/AgentIntegrationsRequest.md index 737b16721..15120717d 100644 --- a/build/docs/AgentIntegrationsRequest.md +++ b/build/docs/AgentIntegrationsRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentIntegrationsResponse.md b/build/docs/AgentIntegrationsResponse.md index 8f6b5bf4d..5390ec6da 100644 --- a/build/docs/AgentIntegrationsResponse.md +++ b/build/docs/AgentIntegrationsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentManagementUnitReference.md b/build/docs/AgentManagementUnitReference.md index 5fc28d869..131928ef5 100644 --- a/build/docs/AgentManagementUnitReference.md +++ b/build/docs/AgentManagementUnitReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentMaxUtilizationResponse.md b/build/docs/AgentMaxUtilizationResponse.md index 545f6107a..f8b4f7c8b 100644 --- a/build/docs/AgentMaxUtilizationResponse.md +++ b/build/docs/AgentMaxUtilizationResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentOwnedMappingPreview.md b/build/docs/AgentOwnedMappingPreview.md index 7bde32486..1a351df41 100644 --- a/build/docs/AgentOwnedMappingPreview.md +++ b/build/docs/AgentOwnedMappingPreview.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentOwnedMappingPreviewListing.md b/build/docs/AgentOwnedMappingPreviewListing.md index bb4aa21e5..bdd23c3a3 100644 --- a/build/docs/AgentOwnedMappingPreviewListing.md +++ b/build/docs/AgentOwnedMappingPreviewListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentOwnedRouting.md b/build/docs/AgentOwnedRouting.md index 53523ab1c..d24a2540d 100644 --- a/build/docs/AgentOwnedRouting.md +++ b/build/docs/AgentOwnedRouting.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentPossibleWorkShiftsRequest.md b/build/docs/AgentPossibleWorkShiftsRequest.md index 487ec9d4f..3ffb08389 100644 --- a/build/docs/AgentPossibleWorkShiftsRequest.md +++ b/build/docs/AgentPossibleWorkShiftsRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentPossibleWorkShiftsResponse.md b/build/docs/AgentPossibleWorkShiftsResponse.md index 8439cff2f..681a6e18f 100644 --- a/build/docs/AgentPossibleWorkShiftsResponse.md +++ b/build/docs/AgentPossibleWorkShiftsResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentQueryAdherenceExplanationsRequest.md b/build/docs/AgentQueryAdherenceExplanationsRequest.md index 27ab3f03e..7ca3ab437 100644 --- a/build/docs/AgentQueryAdherenceExplanationsRequest.md +++ b/build/docs/AgentQueryAdherenceExplanationsRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentQueryAdherenceExplanationsResponse.md b/build/docs/AgentQueryAdherenceExplanationsResponse.md index 21070983b..9bc485940 100644 --- a/build/docs/AgentQueryAdherenceExplanationsResponse.md +++ b/build/docs/AgentQueryAdherenceExplanationsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentQueueTimeRequest.md b/build/docs/AgentQueueTimeRequest.md index ca83fa070..ebb47657c 100644 --- a/build/docs/AgentQueueTimeRequest.md +++ b/build/docs/AgentQueueTimeRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentTimeOffRequestPatch.md b/build/docs/AgentTimeOffRequestPatch.md index 9a7dba79e..c5d154cd8 100644 --- a/build/docs/AgentTimeOffRequestPatch.md +++ b/build/docs/AgentTimeOffRequestPatch.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentUIAPI.md b/build/docs/AgentUIAPI.md index 64c974efe..d9da08cd0 100644 --- a/build/docs/AgentUIAPI.md +++ b/build/docs/AgentUIAPI.md @@ -214,4 +214,4 @@ AgentUIAPI.putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: agentId, body [**AutoAnswerSettings**](AutoAnswerSettings) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentUpdateAlternativeShiftTradeRequest.md b/build/docs/AgentUpdateAlternativeShiftTradeRequest.md index f646e90f6..a5627d04a 100644 --- a/build/docs/AgentUpdateAlternativeShiftTradeRequest.md +++ b/build/docs/AgentUpdateAlternativeShiftTradeRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentVideoSettings.md b/build/docs/AgentVideoSettings.md index cd01ef1a6..003e7bf35 100644 --- a/build/docs/AgentVideoSettings.md +++ b/build/docs/AgentVideoSettings.md @@ -14,4 +14,4 @@ The settings for Agent Video -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlan.md b/build/docs/AgentWorkPlan.md index 594913e6d..3a7059812 100644 --- a/build/docs/AgentWorkPlan.md +++ b/build/docs/AgentWorkPlan.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlanActivity.md b/build/docs/AgentWorkPlanActivity.md index eb3934974..a22b7a156 100644 --- a/build/docs/AgentWorkPlanActivity.md +++ b/build/docs/AgentWorkPlanActivity.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlanBid.md b/build/docs/AgentWorkPlanBid.md index f1d94ff36..a6f068bc7 100644 --- a/build/docs/AgentWorkPlanBid.md +++ b/build/docs/AgentWorkPlanBid.md @@ -18,4 +18,4 @@ Work plan bid reference -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlanBiddingPreference.md b/build/docs/AgentWorkPlanBiddingPreference.md index 846c57ac3..cdadcd996 100644 --- a/build/docs/AgentWorkPlanBiddingPreference.md +++ b/build/docs/AgentWorkPlanBiddingPreference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlanBiddingPreferenceRequest.md b/build/docs/AgentWorkPlanBiddingPreferenceRequest.md index 70da37ac3..9745f3202 100644 --- a/build/docs/AgentWorkPlanBiddingPreferenceRequest.md +++ b/build/docs/AgentWorkPlanBiddingPreferenceRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlanBiddingPreferenceResponse.md b/build/docs/AgentWorkPlanBiddingPreferenceResponse.md index 49a37e496..ece7a2f45 100644 --- a/build/docs/AgentWorkPlanBiddingPreferenceResponse.md +++ b/build/docs/AgentWorkPlanBiddingPreferenceResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlanBids.md b/build/docs/AgentWorkPlanBids.md index c091c2418..2a5cc60da 100644 --- a/build/docs/AgentWorkPlanBids.md +++ b/build/docs/AgentWorkPlanBids.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlanListResponse.md b/build/docs/AgentWorkPlanListResponse.md index 7b0bdfbb1..9e1e70d05 100644 --- a/build/docs/AgentWorkPlanListResponse.md +++ b/build/docs/AgentWorkPlanListResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlanShift.md b/build/docs/AgentWorkPlanShift.md index 3e4b05d6f..702265409 100644 --- a/build/docs/AgentWorkPlanShift.md +++ b/build/docs/AgentWorkPlanShift.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentWorkPlans.md b/build/docs/AgentWorkPlans.md index 083579243..6dea6e5f9 100644 --- a/build/docs/AgentWorkPlans.md +++ b/build/docs/AgentWorkPlans.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentlessEmailSendRequestDto.md b/build/docs/AgentlessEmailSendRequestDto.md index 66fe18467..1f12cd926 100644 --- a/build/docs/AgentlessEmailSendRequestDto.md +++ b/build/docs/AgentlessEmailSendRequestDto.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentlessEmailSendResponseDto.md b/build/docs/AgentlessEmailSendResponseDto.md index 3b1d4f90b..37c067162 100644 --- a/build/docs/AgentlessEmailSendResponseDto.md +++ b/build/docs/AgentlessEmailSendResponseDto.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentsBidAssignedWorkPlanOverrideRequest.md b/build/docs/AgentsBidAssignedWorkPlanOverrideRequest.md index 3d199f202..4a386235e 100644 --- a/build/docs/AgentsBidAssignedWorkPlanOverrideRequest.md +++ b/build/docs/AgentsBidAssignedWorkPlanOverrideRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentsIntegrationsListing.md b/build/docs/AgentsIntegrationsListing.md index a048a9607..3804aa892 100644 --- a/build/docs/AgentsIntegrationsListing.md +++ b/build/docs/AgentsIntegrationsListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AgentsWorkPlansResponse.md b/build/docs/AgentsWorkPlansResponse.md index 960ea8d4f..661f62599 100644 --- a/build/docs/AgentsWorkPlansResponse.md +++ b/build/docs/AgentsWorkPlansResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AggregateMetricData.md b/build/docs/AggregateMetricData.md index 7f32c8920..f0ea2ec3f 100644 --- a/build/docs/AggregateMetricData.md +++ b/build/docs/AggregateMetricData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AggregateViewData.md b/build/docs/AggregateViewData.md index d543a0c6d..fe7706f28 100644 --- a/build/docs/AggregateViewData.md +++ b/build/docs/AggregateViewData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AggregationRange.md b/build/docs/AggregationRange.md index f66c71bf8..24ae93aef 100644 --- a/build/docs/AggregationRange.md +++ b/build/docs/AggregationRange.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AggregationResult.md b/build/docs/AggregationResult.md index 159aa05c5..ecee9c42b 100644 --- a/build/docs/AggregationResult.md +++ b/build/docs/AggregationResult.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AggregationResultEntry.md b/build/docs/AggregationResultEntry.md index fbc52957a..79278910c 100644 --- a/build/docs/AggregationResultEntry.md +++ b/build/docs/AggregationResultEntry.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AiAnswer.md b/build/docs/AiAnswer.md index cb982aba3..faf523b05 100644 --- a/build/docs/AiAnswer.md +++ b/build/docs/AiAnswer.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AiScoring.md b/build/docs/AiScoring.md index 52983238e..4350a9247 100644 --- a/build/docs/AiScoring.md +++ b/build/docs/AiScoring.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AiScoringSetting.md b/build/docs/AiScoringSetting.md index 9b25dc688..75e4e4a57 100644 --- a/build/docs/AiScoringSetting.md +++ b/build/docs/AiScoringSetting.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AiScoringSettings.md b/build/docs/AiScoringSettings.md index e6349f5d5..68103d6bc 100644 --- a/build/docs/AiScoringSettings.md +++ b/build/docs/AiScoringSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertListing.md b/build/docs/AlertListing.md index 844886e68..eaeec4bce 100644 --- a/build/docs/AlertListing.md +++ b/build/docs/AlertListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertNotification.md b/build/docs/AlertNotification.md index 32edb2d50..432264d9a 100644 --- a/build/docs/AlertNotification.md +++ b/build/docs/AlertNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertRequest.md b/build/docs/AlertRequest.md index d2b21d462..e8af3f7c7 100644 --- a/build/docs/AlertRequest.md +++ b/build/docs/AlertRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertRuleProperties.md b/build/docs/AlertRuleProperties.md index 58f7b2bc6..4af5e24cd 100644 --- a/build/docs/AlertRuleProperties.md +++ b/build/docs/AlertRuleProperties.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertSummary.md b/build/docs/AlertSummary.md index 0e8fa0353..28270cf9c 100644 --- a/build/docs/AlertSummary.md +++ b/build/docs/AlertSummary.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertSummaryEntity.md b/build/docs/AlertSummaryEntity.md index 037d918fd..e8f8d406c 100644 --- a/build/docs/AlertSummaryEntity.md +++ b/build/docs/AlertSummaryEntity.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertablePresences.md b/build/docs/AlertablePresences.md index f15f47f7b..d46a8fb03 100644 --- a/build/docs/AlertablePresences.md +++ b/build/docs/AlertablePresences.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertingAPI.md b/build/docs/AlertingAPI.md index 7eb47d158..1b6703fab 100644 --- a/build/docs/AlertingAPI.md +++ b/build/docs/AlertingAPI.md @@ -1261,4 +1261,4 @@ AlertingAPI.putAlertingRule(ruleId: ruleId, body: body) { (response, error) in [**CommonRule**](CommonRule) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlertingUnreadStatus.md b/build/docs/AlertingUnreadStatus.md index a9e79d452..e05c85eaa 100644 --- a/build/docs/AlertingUnreadStatus.md +++ b/build/docs/AlertingUnreadStatus.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AllTimePoints.md b/build/docs/AllTimePoints.md index 6d9db20b0..d6d0d2e62 100644 --- a/build/docs/AllTimePoints.md +++ b/build/docs/AllTimePoints.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Alteration.md b/build/docs/Alteration.md index 4a10598a1..8d2fc9048 100644 --- a/build/docs/Alteration.md +++ b/build/docs/Alteration.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftAgentScheduledShift.md b/build/docs/AlternativeShiftAgentScheduledShift.md index e5811218b..c1a64d878 100644 --- a/build/docs/AlternativeShiftAgentScheduledShift.md +++ b/build/docs/AlternativeShiftAgentScheduledShift.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftAsyncResponse.md b/build/docs/AlternativeShiftAsyncResponse.md index 7ec5efb92..0214a24a9 100644 --- a/build/docs/AlternativeShiftAsyncResponse.md +++ b/build/docs/AlternativeShiftAsyncResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftBuSettingsResponse.md b/build/docs/AlternativeShiftBuSettingsResponse.md index b82da557c..fe107651e 100644 --- a/build/docs/AlternativeShiftBuSettingsResponse.md +++ b/build/docs/AlternativeShiftBuSettingsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftBulkUpdateTradesResponseTemplate.md b/build/docs/AlternativeShiftBulkUpdateTradesResponseTemplate.md index 476528d6f..947d0f2a6 100644 --- a/build/docs/AlternativeShiftBulkUpdateTradesResponseTemplate.md +++ b/build/docs/AlternativeShiftBulkUpdateTradesResponseTemplate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftJobReference.md b/build/docs/AlternativeShiftJobReference.md index 9c7b49513..a991625a3 100644 --- a/build/docs/AlternativeShiftJobReference.md +++ b/build/docs/AlternativeShiftJobReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftJobResponse.md b/build/docs/AlternativeShiftJobResponse.md index 36bf851cd..22498c593 100644 --- a/build/docs/AlternativeShiftJobResponse.md +++ b/build/docs/AlternativeShiftJobResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftNotification.md b/build/docs/AlternativeShiftNotification.md index 7ef635bb5..c78d45f3f 100644 --- a/build/docs/AlternativeShiftNotification.md +++ b/build/docs/AlternativeShiftNotification.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftOffersRequest.md b/build/docs/AlternativeShiftOffersRequest.md index b2763d16f..f33b32322 100644 --- a/build/docs/AlternativeShiftOffersRequest.md +++ b/build/docs/AlternativeShiftOffersRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftOffersViewResponseTemplate.md b/build/docs/AlternativeShiftOffersViewResponseTemplate.md index a7d21ebb7..abd597c0c 100644 --- a/build/docs/AlternativeShiftOffersViewResponseTemplate.md +++ b/build/docs/AlternativeShiftOffersViewResponseTemplate.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftScheduleLookup.md b/build/docs/AlternativeShiftScheduleLookup.md index b5514845c..cc4330a55 100644 --- a/build/docs/AlternativeShiftScheduleLookup.md +++ b/build/docs/AlternativeShiftScheduleLookup.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftSearchOffersRequest.md b/build/docs/AlternativeShiftSearchOffersRequest.md index 6b6c8600c..97ae95aec 100644 --- a/build/docs/AlternativeShiftSearchOffersRequest.md +++ b/build/docs/AlternativeShiftSearchOffersRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftTradeBulkUpdateTemplateItem.md b/build/docs/AlternativeShiftTradeBulkUpdateTemplateItem.md index ad1b96ce5..0635fcc0c 100644 --- a/build/docs/AlternativeShiftTradeBulkUpdateTemplateItem.md +++ b/build/docs/AlternativeShiftTradeBulkUpdateTemplateItem.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftTradeListing.md b/build/docs/AlternativeShiftTradeListing.md index b14feaa6a..d9ba63077 100644 --- a/build/docs/AlternativeShiftTradeListing.md +++ b/build/docs/AlternativeShiftTradeListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftTradeResponse.md b/build/docs/AlternativeShiftTradeResponse.md index de85b617d..9c4a3e644 100644 --- a/build/docs/AlternativeShiftTradeResponse.md +++ b/build/docs/AlternativeShiftTradeResponse.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AlternativeShiftTradesViewResponseTemplate.md b/build/docs/AlternativeShiftTradesViewResponseTemplate.md index 72433a2f5..b3b20c962 100644 --- a/build/docs/AlternativeShiftTradesViewResponseTemplate.md +++ b/build/docs/AlternativeShiftTradesViewResponseTemplate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AmazonLexRequest.md b/build/docs/AmazonLexRequest.md index a3d9ac1ff..4c9acb64e 100644 --- a/build/docs/AmazonLexRequest.md +++ b/build/docs/AmazonLexRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsAPI.md b/build/docs/AnalyticsAPI.md index 5a6c83930..88167d6fd 100644 --- a/build/docs/AnalyticsAPI.md +++ b/build/docs/AnalyticsAPI.md @@ -2910,4 +2910,4 @@ AnalyticsAPI.putAnalyticsDataretentionSettings(body: body) { (response, error) i [**AnalyticsDataRetentionResponse**](AnalyticsDataRetentionResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsAgentGroup.md b/build/docs/AnalyticsAgentGroup.md index df475300b..65199a03a 100644 --- a/build/docs/AnalyticsAgentGroup.md +++ b/build/docs/AnalyticsAgentGroup.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsConversation.md b/build/docs/AnalyticsConversation.md index ee7df6a1e..05929f64b 100644 --- a/build/docs/AnalyticsConversation.md +++ b/build/docs/AnalyticsConversation.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsConversationAsyncQueryResponse.md b/build/docs/AnalyticsConversationAsyncQueryResponse.md index dfa52930f..cdc1593dd 100644 --- a/build/docs/AnalyticsConversationAsyncQueryResponse.md +++ b/build/docs/AnalyticsConversationAsyncQueryResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsConversationQueryResponse.md b/build/docs/AnalyticsConversationQueryResponse.md index eec408865..62732fe8f 100644 --- a/build/docs/AnalyticsConversationQueryResponse.md +++ b/build/docs/AnalyticsConversationQueryResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsConversationSegment.md b/build/docs/AnalyticsConversationSegment.md index 9da35a953..23fe892ee 100644 --- a/build/docs/AnalyticsConversationSegment.md +++ b/build/docs/AnalyticsConversationSegment.md @@ -34,4 +34,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsConversationWithoutAttributes.md b/build/docs/AnalyticsConversationWithoutAttributes.md index 1a89aae27..36cf0a478 100644 --- a/build/docs/AnalyticsConversationWithoutAttributes.md +++ b/build/docs/AnalyticsConversationWithoutAttributes.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsConversationWithoutAttributesMultiGetResponse.md b/build/docs/AnalyticsConversationWithoutAttributesMultiGetResponse.md index 10d5a0f25..02a12b071 100644 --- a/build/docs/AnalyticsConversationWithoutAttributesMultiGetResponse.md +++ b/build/docs/AnalyticsConversationWithoutAttributesMultiGetResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsDataRetentionResponse.md b/build/docs/AnalyticsDataRetentionResponse.md index 995b99cc1..43a8cdc48 100644 --- a/build/docs/AnalyticsDataRetentionResponse.md +++ b/build/docs/AnalyticsDataRetentionResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsEvaluation.md b/build/docs/AnalyticsEvaluation.md index 453709f38..775fe08c6 100644 --- a/build/docs/AnalyticsEvaluation.md +++ b/build/docs/AnalyticsEvaluation.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsFlow.md b/build/docs/AnalyticsFlow.md index 20e55071c..400567330 100644 --- a/build/docs/AnalyticsFlow.md +++ b/build/docs/AnalyticsFlow.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsFlowOutcome.md b/build/docs/AnalyticsFlowOutcome.md index b667e6f88..625e1885e 100644 --- a/build/docs/AnalyticsFlowOutcome.md +++ b/build/docs/AnalyticsFlowOutcome.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsMediaEndpointStat.md b/build/docs/AnalyticsMediaEndpointStat.md index 69a520f50..6161dfe55 100644 --- a/build/docs/AnalyticsMediaEndpointStat.md +++ b/build/docs/AnalyticsMediaEndpointStat.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsParticipant.md b/build/docs/AnalyticsParticipant.md index 3db1b9a41..8819e5b7b 100644 --- a/build/docs/AnalyticsParticipant.md +++ b/build/docs/AnalyticsParticipant.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsParticipantWithoutAttributes.md b/build/docs/AnalyticsParticipantWithoutAttributes.md index 7e656fc15..3f84f671e 100644 --- a/build/docs/AnalyticsParticipantWithoutAttributes.md +++ b/build/docs/AnalyticsParticipantWithoutAttributes.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsProperty.md b/build/docs/AnalyticsProperty.md index f447b56d4..286aa33c1 100644 --- a/build/docs/AnalyticsProperty.md +++ b/build/docs/AnalyticsProperty.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsProposedAgent.md b/build/docs/AnalyticsProposedAgent.md index 5ff2d038e..6115616ec 100644 --- a/build/docs/AnalyticsProposedAgent.md +++ b/build/docs/AnalyticsProposedAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsQueryAggregation.md b/build/docs/AnalyticsQueryAggregation.md index 3879af501..35648bb32 100644 --- a/build/docs/AnalyticsQueryAggregation.md +++ b/build/docs/AnalyticsQueryAggregation.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsReportingSettings.md b/build/docs/AnalyticsReportingSettings.md index d8757abfb..6fa070714 100644 --- a/build/docs/AnalyticsReportingSettings.md +++ b/build/docs/AnalyticsReportingSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsResolution.md b/build/docs/AnalyticsResolution.md index a44d8608e..a6bb2df57 100644 --- a/build/docs/AnalyticsResolution.md +++ b/build/docs/AnalyticsResolution.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsRoutingStatusRecord.md b/build/docs/AnalyticsRoutingStatusRecord.md index 65e1dd8d1..e061e644a 100644 --- a/build/docs/AnalyticsRoutingStatusRecord.md +++ b/build/docs/AnalyticsRoutingStatusRecord.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsScoredAgent.md b/build/docs/AnalyticsScoredAgent.md index 71358a509..04e56770d 100644 --- a/build/docs/AnalyticsScoredAgent.md +++ b/build/docs/AnalyticsScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsSession.md b/build/docs/AnalyticsSession.md index e68e548fc..e4845ac11 100644 --- a/build/docs/AnalyticsSession.md +++ b/build/docs/AnalyticsSession.md @@ -92,4 +92,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsSessionMetric.md b/build/docs/AnalyticsSessionMetric.md index 2cefd434f..3ecd2f497 100644 --- a/build/docs/AnalyticsSessionMetric.md +++ b/build/docs/AnalyticsSessionMetric.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsSurvey.md b/build/docs/AnalyticsSurvey.md index 1b45a3d6a..bc2122e24 100644 --- a/build/docs/AnalyticsSurvey.md +++ b/build/docs/AnalyticsSurvey.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsUserDetail.md b/build/docs/AnalyticsUserDetail.md index 02647bdef..62cf46376 100644 --- a/build/docs/AnalyticsUserDetail.md +++ b/build/docs/AnalyticsUserDetail.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsUserDetailsAsyncQueryResponse.md b/build/docs/AnalyticsUserDetailsAsyncQueryResponse.md index ab6ffcbd6..6ac351a1e 100644 --- a/build/docs/AnalyticsUserDetailsAsyncQueryResponse.md +++ b/build/docs/AnalyticsUserDetailsAsyncQueryResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsUserDetailsQueryResponse.md b/build/docs/AnalyticsUserDetailsQueryResponse.md index 7ddbdd269..7511ed3c9 100644 --- a/build/docs/AnalyticsUserDetailsQueryResponse.md +++ b/build/docs/AnalyticsUserDetailsQueryResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnalyticsUserPresenceRecord.md b/build/docs/AnalyticsUserPresenceRecord.md index 230125a85..f59128c77 100644 --- a/build/docs/AnalyticsUserPresenceRecord.md +++ b/build/docs/AnalyticsUserPresenceRecord.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Annotation.md b/build/docs/Annotation.md index f56949052..9d433aced 100644 --- a/build/docs/Annotation.md +++ b/build/docs/Annotation.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnswerGenerationConfig.md b/build/docs/AnswerGenerationConfig.md index 17ca52f96..9f742dec9 100644 --- a/build/docs/AnswerGenerationConfig.md +++ b/build/docs/AnswerGenerationConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnswerGenerationDocument.md b/build/docs/AnswerGenerationDocument.md index 9b7222172..db9b17a34 100644 --- a/build/docs/AnswerGenerationDocument.md +++ b/build/docs/AnswerGenerationDocument.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AnswerOption.md b/build/docs/AnswerOption.md index e5e81708c..90f8f277e 100644 --- a/build/docs/AnswerOption.md +++ b/build/docs/AnswerOption.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ApiUsageClientQuery.md b/build/docs/ApiUsageClientQuery.md index ba0d56095..094e3cbbc 100644 --- a/build/docs/ApiUsageClientQuery.md +++ b/build/docs/ApiUsageClientQuery.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ApiUsageOrganizationQuery.md b/build/docs/ApiUsageOrganizationQuery.md index 3515126bc..1cea75f41 100644 --- a/build/docs/ApiUsageOrganizationQuery.md +++ b/build/docs/ApiUsageOrganizationQuery.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ApiUsageQueryResult.md b/build/docs/ApiUsageQueryResult.md index b1d46a166..4dc1e385d 100644 --- a/build/docs/ApiUsageQueryResult.md +++ b/build/docs/ApiUsageQueryResult.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ApiUsageRow.md b/build/docs/ApiUsageRow.md index b9a2689a6..0640678de 100644 --- a/build/docs/ApiUsageRow.md +++ b/build/docs/ApiUsageRow.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ApiUsageSimpleSearch.md b/build/docs/ApiUsageSimpleSearch.md index 1231216f9..7f67c18dc 100644 --- a/build/docs/ApiUsageSimpleSearch.md +++ b/build/docs/ApiUsageSimpleSearch.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AppEvent.md b/build/docs/AppEvent.md index a1df9c9c7..3ec9acf78 100644 --- a/build/docs/AppEvent.md +++ b/build/docs/AppEvent.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AppEventRequest.md b/build/docs/AppEventRequest.md index 91e9e61ba..3fe9be949 100644 --- a/build/docs/AppEventRequest.md +++ b/build/docs/AppEventRequest.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AppEventResponse.md b/build/docs/AppEventResponse.md index 9ffc4ba1a..16b06fafe 100644 --- a/build/docs/AppEventResponse.md +++ b/build/docs/AppEventResponse.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AppEventResponseSession.md b/build/docs/AppEventResponseSession.md index a71c1ebaa..5b5b8061b 100644 --- a/build/docs/AppEventResponseSession.md +++ b/build/docs/AppEventResponseSession.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AppendToDncActionSettings.md b/build/docs/AppendToDncActionSettings.md index 24d409422..88d67841c 100644 --- a/build/docs/AppendToDncActionSettings.md +++ b/build/docs/AppendToDncActionSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ApprovalNamespace.md b/build/docs/ApprovalNamespace.md index cb9aceda2..92de0d60d 100644 --- a/build/docs/ApprovalNamespace.md +++ b/build/docs/ApprovalNamespace.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectAPI.md b/build/docs/ArchitectAPI.md index 0b7358306..22440b2d4 100644 --- a/build/docs/ArchitectAPI.md +++ b/build/docs/ArchitectAPI.md @@ -1211,11 +1211,11 @@ ArchitectAPI.getArchitectDependencytracking(name: name, pageNumber: pageNumber, | **name** | **String**| Object name to search for | | | **pageNumber** | **Int**| Page number | [optional] | | **pageSize** | **Int**| Page size | [optional] | -| **objectType** | [**[String]**](String)| Object type(s) to search for | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **objectType** | [**[String]**](String)| Object type(s) to search for | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **consumedResources** | **Bool**| Include resources each result item consumes | [optional] | | **consumingResources** | **Bool**| Include resources that consume each result item | [optional] | -| **consumedResourceType** | [**[String]**](String)| Types of consumed resources to return, if consumed resources are requested | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | -| **consumingResourceType** | [**[String]**](String)| Types of consuming resources to return, if consuming resources are requested | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **consumedResourceType** | [**[String]**](String)| Types of consumed resources to return, if consumed resources are requested | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **consumingResourceType** | [**[String]**](String)| Types of consuming resources to return, if consuming resources are requested | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | ### Return type @@ -1318,8 +1318,8 @@ ArchitectAPI.getArchitectDependencytrackingConsumedresources(_id: _id, version: | ------------- | ------------- | ------------- | ------------- | | **_id** | **String**| Consuming object ID | | | **version** | **String**| Consuming object version | | -| **objectType** | **String**| Consuming object type. Only versioned types are allowed here. |
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | -| **resourceType** | [**[String]**](String)| Types of consumed resources to show | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **objectType** | **String**| Consuming object type. Only versioned types are allowed here. |
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **resourceType** | [**[String]**](String)| Types of consumed resources to show | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **pageNumber** | **Int**| Page number | [optional] | | **pageSize** | **Int**| Page size | [optional] | @@ -1378,8 +1378,8 @@ ArchitectAPI.getArchitectDependencytrackingConsumingresources(_id: _id, objectTy | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **_id** | **String**| Consumed object ID | | -| **objectType** | **String**| Consumed object type |
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | -| **resourceType** | [**[String]**](String)| Types of consuming resources to show. Only versioned types are allowed here. | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **objectType** | **String**| Consumed object type |
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **resourceType** | [**[String]**](String)| Types of consuming resources to show. Only versioned types are allowed here. | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **version** | **String**| Object version | [optional] | | **pageNumber** | **Int**| Page number | [optional] | | **pageSize** | **Int**| Page size | [optional] | @@ -1440,10 +1440,10 @@ ArchitectAPI.getArchitectDependencytrackingDeletedresourceconsumers(name: name, | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **name** | **String**| Name to search for | [optional] | -| **objectType** | [**[String]**](String)| Object type(s) to search for | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **objectType** | [**[String]**](String)| Object type(s) to search for | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **flowFilter** | **String**| Show only checkedIn or published flows | [optional]
**Values**: checkedin ("checkedIn"), published ("published") | | **consumedResources** | **Bool**| Return consumed resources? | [optional] | -| **consumedResourceType** | [**[String]**](String)| Resource type(s) to return | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **consumedResourceType** | [**[String]**](String)| Resource type(s) to return | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **pageNumber** | **Int**| Page number | [optional] | | **pageSize** | **Int**| Page size | [optional] | @@ -1504,11 +1504,11 @@ ArchitectAPI.getArchitectDependencytrackingObject(_id: _id, version: version, ob | ------------- | ------------- | ------------- | ------------- | | **_id** | **String**| Object ID | | | **version** | **String**| Object version | [optional] | -| **objectType** | **String**| Object type | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **objectType** | **String**| Object type | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **consumedResources** | **Bool**| Include resources this item consumes | [optional] | | **consumingResources** | **Bool**| Include resources that consume this item | [optional] | -| **consumedResourceType** | [**[String]**](String)| Types of consumed resources to return, if consumed resources are requested | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | -| **consumingResourceType** | [**[String]**](String)| Types of consuming resources to return, if consuming resources are requested | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **consumedResourceType** | [**[String]**](String)| Types of consumed resources to return, if consumed resources are requested | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **consumingResourceType** | [**[String]**](String)| Types of consuming resources to return, if consuming resources are requested | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **consumedResourceRequest** | **Bool**| Indicate that this is going to look up a consumed resource object | [optional] | @@ -1667,9 +1667,9 @@ ArchitectAPI.getArchitectDependencytrackingUpdatedresourceconsumers(name: name, | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **name** | **String**| Name to search for | [optional] | -| **objectType** | [**[String]**](String)| Object type(s) to search for | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **objectType** | [**[String]**](String)| Object type(s) to search for | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **consumedResources** | **Bool**| Return consumed resources? | [optional] | -| **consumedResourceType** | [**[String]**](String)| Resource type(s) to return | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | +| **consumedResourceType** | [**[String]**](String)| Resource type(s) to return | [optional]
**Values**: acdlanguage ("ACDLANGUAGE"), acdskill ("ACDSKILL"), acdwrapupcode ("ACDWRAPUPCODE"), audioconnectorbot ("AUDIOCONNECTORBOT"), botconnectorbot ("BOTCONNECTORBOT"), botconnectorintegration ("BOTCONNECTORINTEGRATION"), botflow ("BOTFLOW"), bridgeaction ("BRIDGEACTION"), commonmoduleflow ("COMMONMODULEFLOW"), composerscript ("COMPOSERSCRIPT"), contactlist ("CONTACTLIST"), dataaction ("DATAACTION"), datatable ("DATATABLE"), decisiontable ("DECISIONTABLE"), dialogenginebot ("DIALOGENGINEBOT"), dialogenginebotversion ("DIALOGENGINEBOTVERSION"), dialogflowagent ("DIALOGFLOWAGENT"), dialogflowcxagent ("DIALOGFLOWCXAGENT"), digitalbotflow ("DIGITALBOTFLOW"), emailroute ("EMAILROUTE"), emergencygroup ("EMERGENCYGROUP"), flowaction ("FLOWACTION"), flowdatatype ("FLOWDATATYPE"), flowmilestone ("FLOWMILESTONE"), flowoutcome ("FLOWOUTCOME"), grammar ("GRAMMAR"), group ("GROUP"), image ("IMAGE"), inboundcallflow ("INBOUNDCALLFLOW"), inboundchatflow ("INBOUNDCHATFLOW"), inboundemailflow ("INBOUNDEMAILFLOW"), inboundshortmessageflow ("INBOUNDSHORTMESSAGEFLOW"), inqueuecallflow ("INQUEUECALLFLOW"), inqueueemailflow ("INQUEUEEMAILFLOW"), inqueueshortmessageflow ("INQUEUESHORTMESSAGEFLOW"), ivrconfiguration ("IVRCONFIGURATION"), knowledgebase ("KNOWLEDGEBASE"), knowledgebasedocument ("KNOWLEDGEBASEDOCUMENT"), language ("LANGUAGE"), lexbot ("LEXBOT"), lexbotalias ("LEXBOTALIAS"), lexv2bot ("LEXV2BOT"), lexv2botalias ("LEXV2BOTALIAS"), nludomain ("NLUDOMAIN"), nuancemixbot ("NUANCEMIXBOT"), nuancemixintegration ("NUANCEMIXINTEGRATION"), oauthclient ("OAUTHCLIENT"), outboundcallflow ("OUTBOUNDCALLFLOW"), queue ("QUEUE"), recordingpolicy ("RECORDINGPOLICY"), response ("RESPONSE"), schedule ("SCHEDULE"), schedulegroup ("SCHEDULEGROUP"), secureaction ("SECUREACTION"), securecallflow ("SECURECALLFLOW"), smsphonenumber ("SMSPHONENUMBER"), sttengine ("STTENGINE"), surveyform ("SURVEYFORM"), surveyinviteflow ("SURVEYINVITEFLOW"), systemprompt ("SYSTEMPROMPT"), ttsengine ("TTSENGINE"), ttsvoice ("TTSVOICE"), user ("USER"), userprompt ("USERPROMPT"), utilizationlabel ("UTILIZATIONLABEL"), voiceflow ("VOICEFLOW"), voicemailflow ("VOICEMAILFLOW"), voicesurveyflow ("VOICESURVEYFLOW"), widget ("WIDGET"), workflow ("WORKFLOW"), workitemflow ("WORKITEMFLOW"), worktype ("WORKTYPE") | | **pageNumber** | **Int**| Page number | [optional] | | **pageSize** | **Int**| Page size | [optional] | @@ -7873,4 +7873,4 @@ ArchitectAPI.putFlowsOutcome(flowOutcomeId: flowOutcomeId, body: body) { (respon [**Operation**](Operation) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectDependencyTrackingBuildNotificationClient.md b/build/docs/ArchitectDependencyTrackingBuildNotificationClient.md index 567ae6a44..fd1a126b2 100644 --- a/build/docs/ArchitectDependencyTrackingBuildNotificationClient.md +++ b/build/docs/ArchitectDependencyTrackingBuildNotificationClient.md @@ -12,4 +12,4 @@ The client who initiated the change. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification.md b/build/docs/ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification.md index eb2a29d3e..6acc214e5 100644 --- a/build/docs/ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification.md +++ b/build/docs/ArchitectDependencyTrackingBuildNotificationDependencyTrackingBuildNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectDependencyTrackingBuildNotificationHomeOrganization.md b/build/docs/ArchitectDependencyTrackingBuildNotificationHomeOrganization.md index b910bff52..20bfa0af2 100644 --- a/build/docs/ArchitectDependencyTrackingBuildNotificationHomeOrganization.md +++ b/build/docs/ArchitectDependencyTrackingBuildNotificationHomeOrganization.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectDependencyTrackingBuildNotificationUser.md b/build/docs/ArchitectDependencyTrackingBuildNotificationUser.md index 03b1b6c44..0be91d409 100644 --- a/build/docs/ArchitectDependencyTrackingBuildNotificationUser.md +++ b/build/docs/ArchitectDependencyTrackingBuildNotificationUser.md @@ -13,4 +13,4 @@ The user who initiated the change. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowFields.md b/build/docs/ArchitectFlowFields.md index de2a6efde..2952ed0db 100644 --- a/build/docs/ArchitectFlowFields.md +++ b/build/docs/ArchitectFlowFields.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowNotificationArchitectOperation.md b/build/docs/ArchitectFlowNotificationArchitectOperation.md index 430601622..d88700174 100644 --- a/build/docs/ArchitectFlowNotificationArchitectOperation.md +++ b/build/docs/ArchitectFlowNotificationArchitectOperation.md @@ -20,4 +20,4 @@ Describes an operation being performed on an Architect object -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowNotificationClient.md b/build/docs/ArchitectFlowNotificationClient.md index 432e56610..91d8983fa 100644 --- a/build/docs/ArchitectFlowNotificationClient.md +++ b/build/docs/ArchitectFlowNotificationClient.md @@ -12,4 +12,4 @@ The client who initiated the change. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowNotificationErrorDetail.md b/build/docs/ArchitectFlowNotificationErrorDetail.md index bd7bcaebe..534028a14 100644 --- a/build/docs/ArchitectFlowNotificationErrorDetail.md +++ b/build/docs/ArchitectFlowNotificationErrorDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowNotificationErrorMessageParams.md b/build/docs/ArchitectFlowNotificationErrorMessageParams.md index f4da639aa..f864d48c2 100644 --- a/build/docs/ArchitectFlowNotificationErrorMessageParams.md +++ b/build/docs/ArchitectFlowNotificationErrorMessageParams.md @@ -11,4 +11,4 @@ The error message params, if the action failed -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowNotificationFlowNotification.md b/build/docs/ArchitectFlowNotificationFlowNotification.md index 84a85ac53..eb8d3ae7e 100644 --- a/build/docs/ArchitectFlowNotificationFlowNotification.md +++ b/build/docs/ArchitectFlowNotificationFlowNotification.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowNotificationFlowVersion.md b/build/docs/ArchitectFlowNotificationFlowVersion.md index 5fb12ccfe..b838f2d95 100644 --- a/build/docs/ArchitectFlowNotificationFlowVersion.md +++ b/build/docs/ArchitectFlowNotificationFlowVersion.md @@ -11,4 +11,4 @@ A bare-bones flow version object -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowNotificationHomeOrganization.md b/build/docs/ArchitectFlowNotificationHomeOrganization.md index 2e8d67ce5..b58f67b87 100644 --- a/build/docs/ArchitectFlowNotificationHomeOrganization.md +++ b/build/docs/ArchitectFlowNotificationHomeOrganization.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowNotificationUser.md b/build/docs/ArchitectFlowNotificationUser.md index a2c5be195..34674382b 100644 --- a/build/docs/ArchitectFlowNotificationUser.md +++ b/build/docs/ArchitectFlowNotificationUser.md @@ -13,4 +13,4 @@ The user who initiated the change. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowOutcomeNotificationArchitectOperation.md b/build/docs/ArchitectFlowOutcomeNotificationArchitectOperation.md index 81ac36e0f..96b26d22e 100644 --- a/build/docs/ArchitectFlowOutcomeNotificationArchitectOperation.md +++ b/build/docs/ArchitectFlowOutcomeNotificationArchitectOperation.md @@ -20,4 +20,4 @@ Describes an operation being performed on an Architect object -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowOutcomeNotificationClient.md b/build/docs/ArchitectFlowOutcomeNotificationClient.md index 823954dab..9af75852a 100644 --- a/build/docs/ArchitectFlowOutcomeNotificationClient.md +++ b/build/docs/ArchitectFlowOutcomeNotificationClient.md @@ -12,4 +12,4 @@ The client who initiated the change. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowOutcomeNotificationErrorDetail.md b/build/docs/ArchitectFlowOutcomeNotificationErrorDetail.md index 2ae7f7ad2..f3991f473 100644 --- a/build/docs/ArchitectFlowOutcomeNotificationErrorDetail.md +++ b/build/docs/ArchitectFlowOutcomeNotificationErrorDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowOutcomeNotificationErrorMessageParams.md b/build/docs/ArchitectFlowOutcomeNotificationErrorMessageParams.md index 6ac7229ae..c4170c25e 100644 --- a/build/docs/ArchitectFlowOutcomeNotificationErrorMessageParams.md +++ b/build/docs/ArchitectFlowOutcomeNotificationErrorMessageParams.md @@ -11,4 +11,4 @@ The error message params, if the action failed -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowOutcomeNotificationFlowOutcomeNotification.md b/build/docs/ArchitectFlowOutcomeNotificationFlowOutcomeNotification.md index 4ffc5a8c7..ccfc094eb 100644 --- a/build/docs/ArchitectFlowOutcomeNotificationFlowOutcomeNotification.md +++ b/build/docs/ArchitectFlowOutcomeNotificationFlowOutcomeNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowOutcomeNotificationHomeOrganization.md b/build/docs/ArchitectFlowOutcomeNotificationHomeOrganization.md index 4abc942a9..6909f32e7 100644 --- a/build/docs/ArchitectFlowOutcomeNotificationHomeOrganization.md +++ b/build/docs/ArchitectFlowOutcomeNotificationHomeOrganization.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectFlowOutcomeNotificationUser.md b/build/docs/ArchitectFlowOutcomeNotificationUser.md index f5706a374..fc2e788b7 100644 --- a/build/docs/ArchitectFlowOutcomeNotificationUser.md +++ b/build/docs/ArchitectFlowOutcomeNotificationUser.md @@ -13,4 +13,4 @@ The user who initiated the change. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectJobMessage.md b/build/docs/ArchitectJobMessage.md index 7bc36ecaa..31803cc93 100644 --- a/build/docs/ArchitectJobMessage.md +++ b/build/docs/ArchitectJobMessage.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectJobStateResponse.md b/build/docs/ArchitectJobStateResponse.md index 4ea8642c2..b52a65ac9 100644 --- a/build/docs/ArchitectJobStateResponse.md +++ b/build/docs/ArchitectJobStateResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectPromptNotificationArchitectOperation.md b/build/docs/ArchitectPromptNotificationArchitectOperation.md index ffc3c6a48..403404692 100644 --- a/build/docs/ArchitectPromptNotificationArchitectOperation.md +++ b/build/docs/ArchitectPromptNotificationArchitectOperation.md @@ -20,4 +20,4 @@ Describes an operation being performed on an Architect object -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectPromptNotificationClient.md b/build/docs/ArchitectPromptNotificationClient.md index 55898a9be..797b0151d 100644 --- a/build/docs/ArchitectPromptNotificationClient.md +++ b/build/docs/ArchitectPromptNotificationClient.md @@ -12,4 +12,4 @@ The client who initiated the change. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectPromptNotificationErrorDetail.md b/build/docs/ArchitectPromptNotificationErrorDetail.md index 17cf092bc..7b1692bf0 100644 --- a/build/docs/ArchitectPromptNotificationErrorDetail.md +++ b/build/docs/ArchitectPromptNotificationErrorDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectPromptNotificationErrorMessageParams.md b/build/docs/ArchitectPromptNotificationErrorMessageParams.md index fe18e5d87..3791c46f1 100644 --- a/build/docs/ArchitectPromptNotificationErrorMessageParams.md +++ b/build/docs/ArchitectPromptNotificationErrorMessageParams.md @@ -11,4 +11,4 @@ The error message params, if the action failed -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectPromptNotificationHomeOrganization.md b/build/docs/ArchitectPromptNotificationHomeOrganization.md index f645001ee..8d57e5b65 100644 --- a/build/docs/ArchitectPromptNotificationHomeOrganization.md +++ b/build/docs/ArchitectPromptNotificationHomeOrganization.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectPromptNotificationPromptNotification.md b/build/docs/ArchitectPromptNotificationPromptNotification.md index ae96cd2c4..9db451ea8 100644 --- a/build/docs/ArchitectPromptNotificationPromptNotification.md +++ b/build/docs/ArchitectPromptNotificationPromptNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectPromptNotificationUser.md b/build/docs/ArchitectPromptNotificationUser.md index fc5ebf6cb..a96a1ae81 100644 --- a/build/docs/ArchitectPromptNotificationUser.md +++ b/build/docs/ArchitectPromptNotificationUser.md @@ -13,4 +13,4 @@ The user who initiated the change. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectPromptResourceNotificationPromptResourceNotification.md b/build/docs/ArchitectPromptResourceNotificationPromptResourceNotification.md index d14c91a05..da5c9eb20 100644 --- a/build/docs/ArchitectPromptResourceNotificationPromptResourceNotification.md +++ b/build/docs/ArchitectPromptResourceNotificationPromptResourceNotification.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchitectSystemPromptResourceNotificationSystemPromptResourceNotification.md b/build/docs/ArchitectSystemPromptResourceNotificationSystemPromptResourceNotification.md index 1588e4bd6..b4f667d8b 100644 --- a/build/docs/ArchitectSystemPromptResourceNotificationSystemPromptResourceNotification.md +++ b/build/docs/ArchitectSystemPromptResourceNotificationSystemPromptResourceNotification.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArchiveRetention.md b/build/docs/ArchiveRetention.md index e328251e6..9fa3b4a2c 100644 --- a/build/docs/ArchiveRetention.md +++ b/build/docs/ArchiveRetention.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArrayNode.md b/build/docs/ArrayNode.md index 87cfca1be..db3abc3f5 100644 --- a/build/docs/ArrayNode.md +++ b/build/docs/ArrayNode.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Article.md b/build/docs/Article.md index 178723d15..8eebc9de1 100644 --- a/build/docs/Article.md +++ b/build/docs/Article.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArticleContent.md b/build/docs/ArticleContent.md index 4d51509bb..0eb5915cc 100644 --- a/build/docs/ArticleContent.md +++ b/build/docs/ArticleContent.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArticleContentBody.md b/build/docs/ArticleContentBody.md index 26592b2f7..107fe8d8a 100644 --- a/build/docs/ArticleContentBody.md +++ b/build/docs/ArticleContentBody.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ArticlesFilter.md b/build/docs/ArticlesFilter.md index 609207afa..99952e02d 100644 --- a/build/docs/ArticlesFilter.md +++ b/build/docs/ArticlesFilter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssessmentForm.md b/build/docs/AssessmentForm.md index aa3abba77..d29c82d40 100644 --- a/build/docs/AssessmentForm.md +++ b/build/docs/AssessmentForm.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssessmentFormQuestion.md b/build/docs/AssessmentFormQuestion.md index 2ae828603..10f751f7e 100644 --- a/build/docs/AssessmentFormQuestion.md +++ b/build/docs/AssessmentFormQuestion.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssessmentFormQuestionGroup.md b/build/docs/AssessmentFormQuestionGroup.md index 9da44aa24..769443e75 100644 --- a/build/docs/AssessmentFormQuestionGroup.md +++ b/build/docs/AssessmentFormQuestionGroup.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssessmentJobListing.md b/build/docs/AssessmentJobListing.md index f2a8d1db2..00c182644 100644 --- a/build/docs/AssessmentJobListing.md +++ b/build/docs/AssessmentJobListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssessmentListing.md b/build/docs/AssessmentListing.md index b07670514..029047b7a 100644 --- a/build/docs/AssessmentListing.md +++ b/build/docs/AssessmentListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssessmentQuestionGroupScore.md b/build/docs/AssessmentQuestionGroupScore.md index 475082b89..3f416dc2a 100644 --- a/build/docs/AssessmentQuestionGroupScore.md +++ b/build/docs/AssessmentQuestionGroupScore.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssessmentQuestionScore.md b/build/docs/AssessmentQuestionScore.md index 0c2193357..c403528a8 100644 --- a/build/docs/AssessmentQuestionScore.md +++ b/build/docs/AssessmentQuestionScore.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssessmentScoringSet.md b/build/docs/AssessmentScoringSet.md index af65728c8..db151ea66 100644 --- a/build/docs/AssessmentScoringSet.md +++ b/build/docs/AssessmentScoringSet.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssignUsers.md b/build/docs/AssignUsers.md index bdf3d02a9..9c24d162b 100644 --- a/build/docs/AssignUsers.md +++ b/build/docs/AssignUsers.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssignedLearningModule.md b/build/docs/AssignedLearningModule.md index 6c8246832..584e12ee3 100644 --- a/build/docs/AssignedLearningModule.md +++ b/build/docs/AssignedLearningModule.md @@ -37,4 +37,4 @@ Learning module response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssignedLearningModuleDomainEntityListing.md b/build/docs/AssignedLearningModuleDomainEntityListing.md index d035d18b5..7e6118ab9 100644 --- a/build/docs/AssignedLearningModuleDomainEntityListing.md +++ b/build/docs/AssignedLearningModuleDomainEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssignedSegment.md b/build/docs/AssignedSegment.md index d68fe83b2..3ee89da8d 100644 --- a/build/docs/AssignedSegment.md +++ b/build/docs/AssignedSegment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssignedWrapupCode.md b/build/docs/AssignedWrapupCode.md index 049d053c7..1b0dfd5f2 100644 --- a/build/docs/AssignedWrapupCode.md +++ b/build/docs/AssignedWrapupCode.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Assignment.md b/build/docs/Assignment.md index b383f0955..0cefc72ab 100644 --- a/build/docs/Assignment.md +++ b/build/docs/Assignment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssignmentError.md b/build/docs/AssignmentError.md index 550e774c3..d378d54c4 100644 --- a/build/docs/AssignmentError.md +++ b/build/docs/AssignmentError.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssignmentValidation.md b/build/docs/AssignmentValidation.md index 3300012b9..c831224c4 100644 --- a/build/docs/AssignmentValidation.md +++ b/build/docs/AssignmentValidation.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssistanceCondition.md b/build/docs/AssistanceCondition.md index b6a392bfc..6d7ce4285 100644 --- a/build/docs/AssistanceCondition.md +++ b/build/docs/AssistanceCondition.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Assistant.md b/build/docs/Assistant.md index 53fa735e7..9a6e77d03 100644 --- a/build/docs/Assistant.md +++ b/build/docs/Assistant.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssistantListing.md b/build/docs/AssistantListing.md index 310581c04..6f4bd0a3a 100644 --- a/build/docs/AssistantListing.md +++ b/build/docs/AssistantListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssistantQueue.md b/build/docs/AssistantQueue.md index 6eff2095e..f618dd07f 100644 --- a/build/docs/AssistantQueue.md +++ b/build/docs/AssistantQueue.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssistantQueueListing.md b/build/docs/AssistantQueueListing.md index c30e5c8ac..3982a1374 100644 --- a/build/docs/AssistantQueueListing.md +++ b/build/docs/AssistantQueueListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AssociatedValueField.md b/build/docs/AssociatedValueField.md index 61776e8da..ba8053901 100644 --- a/build/docs/AssociatedValueField.md +++ b/build/docs/AssociatedValueField.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AsyncConversationQuery.md b/build/docs/AsyncConversationQuery.md index c2fb82235..bccb98e8d 100644 --- a/build/docs/AsyncConversationQuery.md +++ b/build/docs/AsyncConversationQuery.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AsyncForecastOperationResult.md b/build/docs/AsyncForecastOperationResult.md index fa2a47061..04f0af4b0 100644 --- a/build/docs/AsyncForecastOperationResult.md +++ b/build/docs/AsyncForecastOperationResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AsyncIntradayResponse.md b/build/docs/AsyncIntradayResponse.md index 11a3a3475..acbdfd5f1 100644 --- a/build/docs/AsyncIntradayResponse.md +++ b/build/docs/AsyncIntradayResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AsyncJob.md b/build/docs/AsyncJob.md index a8d50464a..aae6344a9 100644 --- a/build/docs/AsyncJob.md +++ b/build/docs/AsyncJob.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AsyncQueryResponse.md b/build/docs/AsyncQueryResponse.md index cf521a678..9a99b2b4a 100644 --- a/build/docs/AsyncQueryResponse.md +++ b/build/docs/AsyncQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AsyncQueryStatus.md b/build/docs/AsyncQueryStatus.md index 088eb4c23..66060888a 100644 --- a/build/docs/AsyncQueryStatus.md +++ b/build/docs/AsyncQueryStatus.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AsyncUserDetailsQuery.md b/build/docs/AsyncUserDetailsQuery.md index 65d1dc1d2..ca5697592 100644 --- a/build/docs/AsyncUserDetailsQuery.md +++ b/build/docs/AsyncUserDetailsQuery.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Attachment.md b/build/docs/Attachment.md index 4ee04ea44..c4a209934 100644 --- a/build/docs/Attachment.md +++ b/build/docs/Attachment.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AttemptLimits.md b/build/docs/AttemptLimits.md index b48d4076f..afd64ede6 100644 --- a/build/docs/AttemptLimits.md +++ b/build/docs/AttemptLimits.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AttemptLimitsEntityListing.md b/build/docs/AttemptLimitsEntityListing.md index 0f4bded34..4fdc07e54 100644 --- a/build/docs/AttemptLimitsEntityListing.md +++ b/build/docs/AttemptLimitsEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AttendanceStatus.md b/build/docs/AttendanceStatus.md index feb0f6ad2..5859a7dcd 100644 --- a/build/docs/AttendanceStatus.md +++ b/build/docs/AttendanceStatus.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AttendanceStatusListing.md b/build/docs/AttendanceStatusListing.md index d24125b9c..91cd6a1ae 100644 --- a/build/docs/AttendanceStatusListing.md +++ b/build/docs/AttendanceStatusListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Attribute.md b/build/docs/Attribute.md index ca3b8beb4..aaceb474f 100644 --- a/build/docs/Attribute.md +++ b/build/docs/Attribute.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AttributeDetailEventTopicAttributeUpdateEvent.md b/build/docs/AttributeDetailEventTopicAttributeUpdateEvent.md index fa112ddc7..477777afe 100644 --- a/build/docs/AttributeDetailEventTopicAttributeUpdateEvent.md +++ b/build/docs/AttributeDetailEventTopicAttributeUpdateEvent.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AttributeDetailEventTopicCommunication.md b/build/docs/AttributeDetailEventTopicCommunication.md index f545ac128..d57e6a853 100644 --- a/build/docs/AttributeDetailEventTopicCommunication.md +++ b/build/docs/AttributeDetailEventTopicCommunication.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AttributeFilterItem.md b/build/docs/AttributeFilterItem.md index 36d8d269b..837e1197a 100644 --- a/build/docs/AttributeFilterItem.md +++ b/build/docs/AttributeFilterItem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AtzmTimeSlot.md b/build/docs/AtzmTimeSlot.md index bcc071239..220e42999 100644 --- a/build/docs/AtzmTimeSlot.md +++ b/build/docs/AtzmTimeSlot.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AtzmTimeSlotWithTimeZone.md b/build/docs/AtzmTimeSlotWithTimeZone.md index 9b63d8108..3ff5c6edf 100644 --- a/build/docs/AtzmTimeSlotWithTimeZone.md +++ b/build/docs/AtzmTimeSlotWithTimeZone.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AudioConnectorIntegration.md b/build/docs/AudioConnectorIntegration.md index abe885d53..c2ac0eaae 100644 --- a/build/docs/AudioConnectorIntegration.md +++ b/build/docs/AudioConnectorIntegration.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AudioConnectorIntegrationEntityListing.md b/build/docs/AudioConnectorIntegrationEntityListing.md index e77d9753c..99b33fd80 100644 --- a/build/docs/AudioConnectorIntegrationEntityListing.md +++ b/build/docs/AudioConnectorIntegrationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AudioState.md b/build/docs/AudioState.md index c29aecc66..f7d0338cc 100644 --- a/build/docs/AudioState.md +++ b/build/docs/AudioState.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AudioUpdatedEvent.md b/build/docs/AudioUpdatedEvent.md index 75be53018..8c0c14f8e 100644 --- a/build/docs/AudioUpdatedEvent.md +++ b/build/docs/AudioUpdatedEvent.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditAPI.md b/build/docs/AuditAPI.md index 6d9c6b3ec..6b063382c 100644 --- a/build/docs/AuditAPI.md +++ b/build/docs/AuditAPI.md @@ -372,4 +372,4 @@ AuditAPI.postAuditsQueryRealtimeRelated(body: body, expand: expand) { (response, [**AuditRealtimeRelatedResultsResponse**](AuditRealtimeRelatedResultsResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditLogMessage.md b/build/docs/AuditLogMessage.md index 69384a793..2fceacc49 100644 --- a/build/docs/AuditLogMessage.md +++ b/build/docs/AuditLogMessage.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryEntity.md b/build/docs/AuditQueryEntity.md index 2a962e455..b9834ecbf 100644 --- a/build/docs/AuditQueryEntity.md +++ b/build/docs/AuditQueryEntity.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryExecutionLargeResultsResponse.md b/build/docs/AuditQueryExecutionLargeResultsResponse.md index 288ad8782..22e2c09f1 100644 --- a/build/docs/AuditQueryExecutionLargeResultsResponse.md +++ b/build/docs/AuditQueryExecutionLargeResultsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryExecutionResultsResponse.md b/build/docs/AuditQueryExecutionResultsResponse.md index 1a1148a67..17a58bec5 100644 --- a/build/docs/AuditQueryExecutionResultsResponse.md +++ b/build/docs/AuditQueryExecutionResultsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryExecutionStatusResponse.md b/build/docs/AuditQueryExecutionStatusResponse.md index 19122a127..7a3dfe789 100644 --- a/build/docs/AuditQueryExecutionStatusResponse.md +++ b/build/docs/AuditQueryExecutionStatusResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryFilter.md b/build/docs/AuditQueryFilter.md index 8346f2212..7060c4aac 100644 --- a/build/docs/AuditQueryFilter.md +++ b/build/docs/AuditQueryFilter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryRequest.md b/build/docs/AuditQueryRequest.md index b8625e157..8170e5daf 100644 --- a/build/docs/AuditQueryRequest.md +++ b/build/docs/AuditQueryRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryResponse.md b/build/docs/AuditQueryResponse.md index cf078bfee..58d5c2330 100644 --- a/build/docs/AuditQueryResponse.md +++ b/build/docs/AuditQueryResponse.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryService.md b/build/docs/AuditQueryService.md index 612a96186..08caffdd6 100644 --- a/build/docs/AuditQueryService.md +++ b/build/docs/AuditQueryService.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQueryServiceMapping.md b/build/docs/AuditQueryServiceMapping.md index fb9753fea..f4ab9a69a 100644 --- a/build/docs/AuditQueryServiceMapping.md +++ b/build/docs/AuditQueryServiceMapping.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditQuerySort.md b/build/docs/AuditQuerySort.md index 0f99f8a3a..31ebf56a5 100644 --- a/build/docs/AuditQuerySort.md +++ b/build/docs/AuditQuerySort.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditRealtimeQueryRequest.md b/build/docs/AuditRealtimeQueryRequest.md index 0948d7927..45c46620d 100644 --- a/build/docs/AuditRealtimeQueryRequest.md +++ b/build/docs/AuditRealtimeQueryRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditRealtimeQueryResultsResponse.md b/build/docs/AuditRealtimeQueryResultsResponse.md index 2f5cd1ea6..afd7a6d83 100644 --- a/build/docs/AuditRealtimeQueryResultsResponse.md +++ b/build/docs/AuditRealtimeQueryResultsResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditRealtimeRelatedRequest.md b/build/docs/AuditRealtimeRelatedRequest.md index ecaf57dd0..5e226d893 100644 --- a/build/docs/AuditRealtimeRelatedRequest.md +++ b/build/docs/AuditRealtimeRelatedRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditRealtimeRelatedResultsResponse.md b/build/docs/AuditRealtimeRelatedResultsResponse.md index 9f3570e4f..534b292b1 100644 --- a/build/docs/AuditRealtimeRelatedResultsResponse.md +++ b/build/docs/AuditRealtimeRelatedResultsResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditTopicAddressableEntityRef.md b/build/docs/AuditTopicAddressableEntityRef.md index 0d459332a..e7214a508 100644 --- a/build/docs/AuditTopicAddressableEntityRef.md +++ b/build/docs/AuditTopicAddressableEntityRef.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditTopicAuditLogMessage.md b/build/docs/AuditTopicAuditLogMessage.md index e949dc812..afba03fe7 100644 --- a/build/docs/AuditTopicAuditLogMessage.md +++ b/build/docs/AuditTopicAuditLogMessage.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditTopicDomainEntityRef.md b/build/docs/AuditTopicDomainEntityRef.md index ffa91c6b1..0f2514191 100644 --- a/build/docs/AuditTopicDomainEntityRef.md +++ b/build/docs/AuditTopicDomainEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditTopicMessageInfo.md b/build/docs/AuditTopicMessageInfo.md index 0b81b27c8..c470feed9 100644 --- a/build/docs/AuditTopicMessageInfo.md +++ b/build/docs/AuditTopicMessageInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuditTopicPropertyChange.md b/build/docs/AuditTopicPropertyChange.md index 67a8c367e..c280e0a84 100644 --- a/build/docs/AuditTopicPropertyChange.md +++ b/build/docs/AuditTopicPropertyChange.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthenticationSettings.md b/build/docs/AuthenticationSettings.md index 25c38802c..11ae76548 100644 --- a/build/docs/AuthenticationSettings.md +++ b/build/docs/AuthenticationSettings.md @@ -13,4 +13,4 @@ Settings for authenticated webdeployments. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthorizationAPI.md b/build/docs/AuthorizationAPI.md index 5d365dae3..c109a64d3 100644 --- a/build/docs/AuthorizationAPI.md +++ b/build/docs/AuthorizationAPI.md @@ -2386,4 +2386,4 @@ AuthorizationAPI.putUserRoles(subjectId: subjectId, body: body) { (response, err [**UserAuthorization**](UserAuthorization) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthorizationSettings.md b/build/docs/AuthorizationSettings.md index 9fa999128..c58d32a6c 100644 --- a/build/docs/AuthorizationSettings.md +++ b/build/docs/AuthorizationSettings.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthzDivision.md b/build/docs/AuthzDivision.md index 95065065c..e8528e849 100644 --- a/build/docs/AuthzDivision.md +++ b/build/docs/AuthzDivision.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthzDivisionEntityListing.md b/build/docs/AuthzDivisionEntityListing.md index 74c7ed14b..468c0ba3e 100644 --- a/build/docs/AuthzDivisionEntityListing.md +++ b/build/docs/AuthzDivisionEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthzDivisionGrantEntityListing.md b/build/docs/AuthzDivisionGrantEntityListing.md index 6ee3ba2b4..ff860730e 100644 --- a/build/docs/AuthzDivisionGrantEntityListing.md +++ b/build/docs/AuthzDivisionGrantEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthzGrant.md b/build/docs/AuthzGrant.md index a0e1248f5..aecce3421 100644 --- a/build/docs/AuthzGrant.md +++ b/build/docs/AuthzGrant.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthzGrantPolicy.md b/build/docs/AuthzGrantPolicy.md index 33760511b..ffa497f27 100644 --- a/build/docs/AuthzGrantPolicy.md +++ b/build/docs/AuthzGrantPolicy.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthzGrantRole.md b/build/docs/AuthzGrantRole.md index 758b0dc02..0a9b8aeae 100644 --- a/build/docs/AuthzGrantRole.md +++ b/build/docs/AuthzGrantRole.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AuthzSubject.md b/build/docs/AuthzSubject.md index c01bdf723..77400505a 100644 --- a/build/docs/AuthzSubject.md +++ b/build/docs/AuthzSubject.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AutoAnswerSetting.md b/build/docs/AutoAnswerSetting.md index 5c4c4325d..ecf7c71c8 100644 --- a/build/docs/AutoAnswerSetting.md +++ b/build/docs/AutoAnswerSetting.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AutoAnswerSettings.md b/build/docs/AutoAnswerSettings.md index 0da8b7a68..ca29fd9fd 100644 --- a/build/docs/AutoAnswerSettings.md +++ b/build/docs/AutoAnswerSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AutoStart.md b/build/docs/AutoStart.md index 810da2b47..093a3ee58 100644 --- a/build/docs/AutoStart.md +++ b/build/docs/AutoStart.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AutoStatusTransitionDetail.md b/build/docs/AutoStatusTransitionDetail.md index 8af8cfbf3..ae5c23b6f 100644 --- a/build/docs/AutoStatusTransitionDetail.md +++ b/build/docs/AutoStatusTransitionDetail.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AutomaticTimeZoneMappingSettings.md b/build/docs/AutomaticTimeZoneMappingSettings.md index 4d0a1ea70..659783c01 100644 --- a/build/docs/AutomaticTimeZoneMappingSettings.md +++ b/build/docs/AutomaticTimeZoneMappingSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailabilityRange.md b/build/docs/AvailabilityRange.md index 808176828..50538bfea 100644 --- a/build/docs/AvailabilityRange.md +++ b/build/docs/AvailabilityRange.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableMediaType.md b/build/docs/AvailableMediaType.md index 22795f132..3756a7cef 100644 --- a/build/docs/AvailableMediaType.md +++ b/build/docs/AvailableMediaType.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableMediaTypeEntityListing.md b/build/docs/AvailableMediaTypeEntityListing.md index 65df9abb1..b36ca5947 100644 --- a/build/docs/AvailableMediaTypeEntityListing.md +++ b/build/docs/AvailableMediaTypeEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableTime.md b/build/docs/AvailableTime.md index 62a5dac91..145b94fe0 100644 --- a/build/docs/AvailableTime.md +++ b/build/docs/AvailableTime.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableTimeOffRange.md b/build/docs/AvailableTimeOffRange.md index 602c090ae..e4b129502 100644 --- a/build/docs/AvailableTimeOffRange.md +++ b/build/docs/AvailableTimeOffRange.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableTimeOffRequest.md b/build/docs/AvailableTimeOffRequest.md index e11a59296..8837c52c1 100644 --- a/build/docs/AvailableTimeOffRequest.md +++ b/build/docs/AvailableTimeOffRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableTimeOffResponse.md b/build/docs/AvailableTimeOffResponse.md index 65e68ef09..efc75b3bd 100644 --- a/build/docs/AvailableTimeOffResponse.md +++ b/build/docs/AvailableTimeOffResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableTopic.md b/build/docs/AvailableTopic.md index 979c2b20d..e0f75fcd4 100644 --- a/build/docs/AvailableTopic.md +++ b/build/docs/AvailableTopic.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableTopicEntityListing.md b/build/docs/AvailableTopicEntityListing.md index 1119389bd..fda88afe3 100644 --- a/build/docs/AvailableTopicEntityListing.md +++ b/build/docs/AvailableTopicEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/AvailableTranslations.md b/build/docs/AvailableTranslations.md index 429183149..742878006 100644 --- a/build/docs/AvailableTranslations.md +++ b/build/docs/AvailableTranslations.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BackgroundImageSettings.md b/build/docs/BackgroundImageSettings.md index 13f33b526..370f16ae6 100644 --- a/build/docs/BackgroundImageSettings.md +++ b/build/docs/BackgroundImageSettings.md @@ -11,4 +11,4 @@ The settings to Agent Video background image -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BaseMediaSettings.md b/build/docs/BaseMediaSettings.md index 5e155ae79..0b92045fc 100644 --- a/build/docs/BaseMediaSettings.md +++ b/build/docs/BaseMediaSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BaseProgramEntity.md b/build/docs/BaseProgramEntity.md index 3e3f58e9a..8ebbbeae3 100644 --- a/build/docs/BaseProgramEntity.md +++ b/build/docs/BaseProgramEntity.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BaseTopicEntitiy.md b/build/docs/BaseTopicEntitiy.md index f4ca6c0ff..ce40a3225 100644 --- a/build/docs/BaseTopicEntitiy.md +++ b/build/docs/BaseTopicEntitiy.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchConversationEventRequest.md b/build/docs/BatchConversationEventRequest.md index 512c62bde..117458692 100644 --- a/build/docs/BatchConversationEventRequest.md +++ b/build/docs/BatchConversationEventRequest.md @@ -28,4 +28,4 @@ A maximum of 100 events are allowed per request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchDownloadJobResult.md b/build/docs/BatchDownloadJobResult.md index 458aabd28..f44733e02 100644 --- a/build/docs/BatchDownloadJobResult.md +++ b/build/docs/BatchDownloadJobResult.md @@ -6,15 +6,12 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -| **_id** | **String** | The globally unique identifier for the object. | [optional] | -| **name** | **String** | | [optional] | | **conversationId** | **String** | Conversation id of the result | [optional] | | **recordingId** | **String** | Recording id of the result | [optional] | | **resultUrl** | **String** | URL of results... HTTP GET from this location to download results for this item | [optional] | | **contentType** | **String** | Content type of this result | [optional] | | **errorMsg** | **String** | An error message, in case of failed processing will indicate the cause of the failure | [optional] | -| **selfUri** | **String** | The URI for this object | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchDownloadJobStatusResult.md b/build/docs/BatchDownloadJobStatusResult.md index 996dbc2c3..93f68dd39 100644 --- a/build/docs/BatchDownloadJobStatusResult.md +++ b/build/docs/BatchDownloadJobStatusResult.md @@ -11,10 +11,10 @@ | **expectedResultCount** | **Int** | Number of results expected when job is completed, this includes both success and error results. This number could change as recordings are being discovered and processed. | [optional] | | **resultCount** | **Int** | Current number of results available, this includes both success and error results. | [optional] | | **errorCount** | **Int** | Current number of error results. | [optional] | -| **status** | **String** | Current status of the job. This could be either IN_PROGRESS or COMPLETED. A job is considered completed when all the submitted requests have been processed and fulfilled. | [optional] | +| **status** | **String** | Current status of the job. A job is considered completed when all the submitted requests have been processed and fulfilled. | [optional] | | **results** | [**[BatchDownloadJobResult]**](BatchDownloadJobResult) | Current set of results for the job. | [optional] | | **selfUri** | **String** | The URI for this object | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchDownloadJobSubmission.md b/build/docs/BatchDownloadJobSubmission.md index 5e5ff7c93..99e48094e 100644 --- a/build/docs/BatchDownloadJobSubmission.md +++ b/build/docs/BatchDownloadJobSubmission.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchDownloadJobSubmissionResult.md b/build/docs/BatchDownloadJobSubmissionResult.md index bb2c69a3d..6605bdd67 100644 --- a/build/docs/BatchDownloadJobSubmissionResult.md +++ b/build/docs/BatchDownloadJobSubmissionResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchDownloadRequest.md b/build/docs/BatchDownloadRequest.md index 4e5802d83..196127be3 100644 --- a/build/docs/BatchDownloadRequest.md +++ b/build/docs/BatchDownloadRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchEventResponse.md b/build/docs/BatchEventResponse.md index 6fe3ff512..52ed26970 100644 --- a/build/docs/BatchEventResponse.md +++ b/build/docs/BatchEventResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchUserPresenceEventRequest.md b/build/docs/BatchUserPresenceEventRequest.md index 94904ad81..0d49ccf12 100644 --- a/build/docs/BatchUserPresenceEventRequest.md +++ b/build/docs/BatchUserPresenceEventRequest.md @@ -11,4 +11,4 @@ A maximum of 100 events are allowed per request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BatchUserRoutingStatusEventRequest.md b/build/docs/BatchUserRoutingStatusEventRequest.md index c4a9107db..d6e3e0720 100644 --- a/build/docs/BatchUserRoutingStatusEventRequest.md +++ b/build/docs/BatchUserRoutingStatusEventRequest.md @@ -11,4 +11,4 @@ A maximum of 100 events are allowed per request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BenefitAssessment.md b/build/docs/BenefitAssessment.md index 4283a6235..728740cd3 100644 --- a/build/docs/BenefitAssessment.md +++ b/build/docs/BenefitAssessment.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BenefitAssessmentJob.md b/build/docs/BenefitAssessmentJob.md index bf9fae0e9..6dbb9fd43 100644 --- a/build/docs/BenefitAssessmentJob.md +++ b/build/docs/BenefitAssessmentJob.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BidGroupWorkPlanRequest.md b/build/docs/BidGroupWorkPlanRequest.md index f774514f8..3ad58a59e 100644 --- a/build/docs/BidGroupWorkPlanRequest.md +++ b/build/docs/BidGroupWorkPlanRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BidGroupWorkPlanResponse.md b/build/docs/BidGroupWorkPlanResponse.md index 4607d0464..be0318959 100644 --- a/build/docs/BidGroupWorkPlanResponse.md +++ b/build/docs/BidGroupWorkPlanResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BillingAPI.md b/build/docs/BillingAPI.md index 92aba7523..9f154bf86 100644 --- a/build/docs/BillingAPI.md +++ b/build/docs/BillingAPI.md @@ -118,4 +118,4 @@ BillingAPI.getBillingTrusteebillingoverviewTrustorOrgId(trustorOrgId: trustorOrg [**TrusteeBillingOverview**](TrusteeBillingOverview) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BillingUsage.md b/build/docs/BillingUsage.md index 9cb821cc0..18a009ee6 100644 --- a/build/docs/BillingUsage.md +++ b/build/docs/BillingUsage.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BillingUsageReport.md b/build/docs/BillingUsageReport.md index 7da28c78f..e22d6b3bb 100644 --- a/build/docs/BillingUsageReport.md +++ b/build/docs/BillingUsageReport.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BillingUsageResource.md b/build/docs/BillingUsageResource.md index 7973c170a..76103c931 100644 --- a/build/docs/BillingUsageResource.md +++ b/build/docs/BillingUsageResource.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Biography.md b/build/docs/Biography.md index 608fa581b..333dbfe84 100644 --- a/build/docs/Biography.md +++ b/build/docs/Biography.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotAggregateDataContainer.md b/build/docs/BotAggregateDataContainer.md index 0bb47e7df..e7b9c4046 100644 --- a/build/docs/BotAggregateDataContainer.md +++ b/build/docs/BotAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotAggregateQueryClause.md b/build/docs/BotAggregateQueryClause.md index 90069bf19..25cbb1176 100644 --- a/build/docs/BotAggregateQueryClause.md +++ b/build/docs/BotAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotAggregateQueryFilter.md b/build/docs/BotAggregateQueryFilter.md index 7891794fa..261468cfe 100644 --- a/build/docs/BotAggregateQueryFilter.md +++ b/build/docs/BotAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotAggregateQueryPredicate.md b/build/docs/BotAggregateQueryPredicate.md index 7197558e2..23d51a3a9 100644 --- a/build/docs/BotAggregateQueryPredicate.md +++ b/build/docs/BotAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotAggregateQueryResponse.md b/build/docs/BotAggregateQueryResponse.md index 61c40173b..e6cf0bc06 100644 --- a/build/docs/BotAggregateQueryResponse.md +++ b/build/docs/BotAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotAggregationQuery.md b/build/docs/BotAggregationQuery.md index 421339fd5..a0977aa30 100644 --- a/build/docs/BotAggregationQuery.md +++ b/build/docs/BotAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotAggregationView.md b/build/docs/BotAggregationView.md index 9b1867849..ce051b366 100644 --- a/build/docs/BotAggregationView.md +++ b/build/docs/BotAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotChannel.md b/build/docs/BotChannel.md index 5733bad3b..7374848f2 100644 --- a/build/docs/BotChannel.md +++ b/build/docs/BotChannel.md @@ -14,4 +14,4 @@ Channel information relevant to a bot flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotConnectorBot.md b/build/docs/BotConnectorBot.md index c45955c49..5dd2e4ab3 100644 --- a/build/docs/BotConnectorBot.md +++ b/build/docs/BotConnectorBot.md @@ -16,4 +16,4 @@ A botConnector Bot Instance -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotConnectorBotSummaryEntityListing.md b/build/docs/BotConnectorBotSummaryEntityListing.md index 20f66db67..de0fa2423 100644 --- a/build/docs/BotConnectorBotSummaryEntityListing.md +++ b/build/docs/BotConnectorBotSummaryEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotConnectorBotVersion.md b/build/docs/BotConnectorBotVersion.md index 00a1ba3c7..a5a48ca83 100644 --- a/build/docs/BotConnectorBotVersion.md +++ b/build/docs/BotConnectorBotVersion.md @@ -13,4 +13,4 @@ A version description for a botConnector bot. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotConnectorBotVersionSummaryEntityListing.md b/build/docs/BotConnectorBotVersionSummaryEntityListing.md index 011c464f7..a62205377 100644 --- a/build/docs/BotConnectorBotVersionSummaryEntityListing.md +++ b/build/docs/BotConnectorBotVersionSummaryEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotExecutionConfiguration.md b/build/docs/BotExecutionConfiguration.md index f11331152..03e5fbb31 100644 --- a/build/docs/BotExecutionConfiguration.md +++ b/build/docs/BotExecutionConfiguration.md @@ -13,4 +13,4 @@ Model for setting the launch configuration for a Nuance bot available to Genesys -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotFlowSession.md b/build/docs/BotFlowSession.md index 9f14fbd75..891872ced 100644 --- a/build/docs/BotFlowSession.md +++ b/build/docs/BotFlowSession.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotIntent.md b/build/docs/BotIntent.md index c02b3ad38..dfd36fe28 100644 --- a/build/docs/BotIntent.md +++ b/build/docs/BotIntent.md @@ -12,4 +12,4 @@ A botConnector's bot intention -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotList.md b/build/docs/BotList.md index 76bde4d8a..3d91e2c06 100644 --- a/build/docs/BotList.md +++ b/build/docs/BotList.md @@ -11,4 +11,4 @@ A list of BotConnectorBots -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotMessengerProfile.md b/build/docs/BotMessengerProfile.md index 86a465c8d..829bf6a9d 100644 --- a/build/docs/BotMessengerProfile.md +++ b/build/docs/BotMessengerProfile.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotSearchResponse.md b/build/docs/BotSearchResponse.md index 60326f845..565ab1d76 100644 --- a/build/docs/BotSearchResponse.md +++ b/build/docs/BotSearchResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotSearchResponseEntityListing.md b/build/docs/BotSearchResponseEntityListing.md index 29c2d7cf2..d5bdc3171 100644 --- a/build/docs/BotSearchResponseEntityListing.md +++ b/build/docs/BotSearchResponseEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotSlot.md b/build/docs/BotSlot.md index 4ddbaf630..6fe38410f 100644 --- a/build/docs/BotSlot.md +++ b/build/docs/BotSlot.md @@ -12,4 +12,4 @@ Description of a data value returned from an intent -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotSummary.md b/build/docs/BotSummary.md index 88b6dfb5e..7132dd04a 100644 --- a/build/docs/BotSummary.md +++ b/build/docs/BotSummary.md @@ -14,4 +14,4 @@ A summary description for a botConnector bot -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BotVersionSummary.md b/build/docs/BotVersionSummary.md index c5dfcf0df..d0bd780a7 100644 --- a/build/docs/BotVersionSummary.md +++ b/build/docs/BotVersionSummary.md @@ -15,4 +15,4 @@ A version summary for a botConnector bot. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Browser.md b/build/docs/Browser.md index cc5a3d95e..82380914e 100644 --- a/build/docs/Browser.md +++ b/build/docs/Browser.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAbandonRate.md b/build/docs/BuAbandonRate.md index 434983ba1..01ffaa407 100644 --- a/build/docs/BuAbandonRate.md +++ b/build/docs/BuAbandonRate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuActivitySettingsRequest.md b/build/docs/BuActivitySettingsRequest.md index 2d7b30d4f..4c9ecca37 100644 --- a/build/docs/BuActivitySettingsRequest.md +++ b/build/docs/BuActivitySettingsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuActivitySettingsResponse.md b/build/docs/BuActivitySettingsResponse.md index 3cc171bad..b87f49f79 100644 --- a/build/docs/BuActivitySettingsResponse.md +++ b/build/docs/BuActivitySettingsResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleActivity.md b/build/docs/BuAgentScheduleActivity.md index 49929748a..2970f4448 100644 --- a/build/docs/BuAgentScheduleActivity.md +++ b/build/docs/BuAgentScheduleActivity.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleHistoryChange.md b/build/docs/BuAgentScheduleHistoryChange.md index abb9cf5cd..7ca64682e 100644 --- a/build/docs/BuAgentScheduleHistoryChange.md +++ b/build/docs/BuAgentScheduleHistoryChange.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleHistoryChangeMetadata.md b/build/docs/BuAgentScheduleHistoryChangeMetadata.md index bef21a8c8..ac2a4cfc5 100644 --- a/build/docs/BuAgentScheduleHistoryChangeMetadata.md +++ b/build/docs/BuAgentScheduleHistoryChangeMetadata.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleHistoryDeletedChange.md b/build/docs/BuAgentScheduleHistoryDeletedChange.md index 14aa7fb94..a1ee1e309 100644 --- a/build/docs/BuAgentScheduleHistoryDeletedChange.md +++ b/build/docs/BuAgentScheduleHistoryDeletedChange.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleHistoryDroppedChange.md b/build/docs/BuAgentScheduleHistoryDroppedChange.md index 0f1ef221e..1a3c35343 100644 --- a/build/docs/BuAgentScheduleHistoryDroppedChange.md +++ b/build/docs/BuAgentScheduleHistoryDroppedChange.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleHistoryResponse.md b/build/docs/BuAgentScheduleHistoryResponse.md index cf4e9150f..9374637d2 100644 --- a/build/docs/BuAgentScheduleHistoryResponse.md +++ b/build/docs/BuAgentScheduleHistoryResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentSchedulePublishedScheduleReference.md b/build/docs/BuAgentSchedulePublishedScheduleReference.md index 64c65c6c3..208670771 100644 --- a/build/docs/BuAgentSchedulePublishedScheduleReference.md +++ b/build/docs/BuAgentSchedulePublishedScheduleReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleQueryResponse.md b/build/docs/BuAgentScheduleQueryResponse.md index 7b4fc53c5..28e9fa13f 100644 --- a/build/docs/BuAgentScheduleQueryResponse.md +++ b/build/docs/BuAgentScheduleQueryResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleRescheduleResponse.md b/build/docs/BuAgentScheduleRescheduleResponse.md index 00e75813d..0f41b72d8 100644 --- a/build/docs/BuAgentScheduleRescheduleResponse.md +++ b/build/docs/BuAgentScheduleRescheduleResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleSearchResponse.md b/build/docs/BuAgentScheduleSearchResponse.md index 299c37f73..14e99d10b 100644 --- a/build/docs/BuAgentScheduleSearchResponse.md +++ b/build/docs/BuAgentScheduleSearchResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleShift.md b/build/docs/BuAgentScheduleShift.md index e36e6adba..5b75a383f 100644 --- a/build/docs/BuAgentScheduleShift.md +++ b/build/docs/BuAgentScheduleShift.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentScheduleUpdate.md b/build/docs/BuAgentScheduleUpdate.md index 4991d773b..22edde764 100644 --- a/build/docs/BuAgentScheduleUpdate.md +++ b/build/docs/BuAgentScheduleUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentSchedulesQueryResponse.md b/build/docs/BuAgentSchedulesQueryResponse.md index adcb42a2a..021aea819 100644 --- a/build/docs/BuAgentSchedulesQueryResponse.md +++ b/build/docs/BuAgentSchedulesQueryResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAgentSchedulesSearchResponse.md b/build/docs/BuAgentSchedulesSearchResponse.md index 556ee8470..aa07dae9f 100644 --- a/build/docs/BuAgentSchedulesSearchResponse.md +++ b/build/docs/BuAgentSchedulesSearchResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAlternativeShiftJobResponse.md b/build/docs/BuAlternativeShiftJobResponse.md index 557b3ca4c..0598c66f2 100644 --- a/build/docs/BuAlternativeShiftJobResponse.md +++ b/build/docs/BuAlternativeShiftJobResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAsyncAgentSchedulesQueryResponse.md b/build/docs/BuAsyncAgentSchedulesQueryResponse.md index 67820ba9c..a598a521a 100644 --- a/build/docs/BuAsyncAgentSchedulesQueryResponse.md +++ b/build/docs/BuAsyncAgentSchedulesQueryResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAsyncAgentSchedulesSearchResponse.md b/build/docs/BuAsyncAgentSchedulesSearchResponse.md index 05d5f99a7..461558c3b 100644 --- a/build/docs/BuAsyncAgentSchedulesSearchResponse.md +++ b/build/docs/BuAsyncAgentSchedulesSearchResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAsyncScheduleResponse.md b/build/docs/BuAsyncScheduleResponse.md index 432747156..4a29ab5e4 100644 --- a/build/docs/BuAsyncScheduleResponse.md +++ b/build/docs/BuAsyncScheduleResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAsyncScheduleRunResponse.md b/build/docs/BuAsyncScheduleRunResponse.md index 9a5d91b77..349e4f34c 100644 --- a/build/docs/BuAsyncScheduleRunResponse.md +++ b/build/docs/BuAsyncScheduleRunResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuAverageSpeedOfAnswer.md b/build/docs/BuAverageSpeedOfAnswer.md index 6ce22b937..970da31e1 100644 --- a/build/docs/BuAverageSpeedOfAnswer.md +++ b/build/docs/BuAverageSpeedOfAnswer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuCopyScheduleRequest.md b/build/docs/BuCopyScheduleRequest.md index 57deda95e..61aa7f04e 100644 --- a/build/docs/BuCopyScheduleRequest.md +++ b/build/docs/BuCopyScheduleRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuCreateBlankScheduleRequest.md b/build/docs/BuCreateBlankScheduleRequest.md index 82381d8e4..9f2e9e3ff 100644 --- a/build/docs/BuCreateBlankScheduleRequest.md +++ b/build/docs/BuCreateBlankScheduleRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuCreateTimeOffLimitRequest.md b/build/docs/BuCreateTimeOffLimitRequest.md index 44abf391b..71306d827 100644 --- a/build/docs/BuCreateTimeOffLimitRequest.md +++ b/build/docs/BuCreateTimeOffLimitRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuCreateTimeOffPlanRequest.md b/build/docs/BuCreateTimeOffPlanRequest.md index a2caf8f97..d194118c3 100644 --- a/build/docs/BuCreateTimeOffPlanRequest.md +++ b/build/docs/BuCreateTimeOffPlanRequest.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuCurrentAgentScheduleSearchResponse.md b/build/docs/BuCurrentAgentScheduleSearchResponse.md index 169a90877..4b2e11db5 100644 --- a/build/docs/BuCurrentAgentScheduleSearchResponse.md +++ b/build/docs/BuCurrentAgentScheduleSearchResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuForecastGenerationPlanningGroupResult.md b/build/docs/BuForecastGenerationPlanningGroupResult.md index a293571f0..b400d6199 100644 --- a/build/docs/BuForecastGenerationPlanningGroupResult.md +++ b/build/docs/BuForecastGenerationPlanningGroupResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuForecastGenerationResult.md b/build/docs/BuForecastGenerationResult.md index d58f0a0a7..04c3aaee0 100644 --- a/build/docs/BuForecastGenerationResult.md +++ b/build/docs/BuForecastGenerationResult.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuForecastModificationResponse.md b/build/docs/BuForecastModificationResponse.md index d75c68a5f..be319c92e 100644 --- a/build/docs/BuForecastModificationResponse.md +++ b/build/docs/BuForecastModificationResponse.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuForecastResult.md b/build/docs/BuForecastResult.md index 5d8db50a8..7ae558126 100644 --- a/build/docs/BuForecastResult.md +++ b/build/docs/BuForecastResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuForecastResultResponse.md b/build/docs/BuForecastResultResponse.md index 143359eb5..a75034464 100644 --- a/build/docs/BuForecastResultResponse.md +++ b/build/docs/BuForecastResultResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuForecastStaffingRequirementsResult.md b/build/docs/BuForecastStaffingRequirementsResult.md index 227ff2e2c..6b1e43ec6 100644 --- a/build/docs/BuForecastStaffingRequirementsResult.md +++ b/build/docs/BuForecastStaffingRequirementsResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuForecastStaffingRequirementsResultResponse.md b/build/docs/BuForecastStaffingRequirementsResultResponse.md index 75e34d466..2c4ad2ed2 100644 --- a/build/docs/BuForecastStaffingRequirementsResultResponse.md +++ b/build/docs/BuForecastStaffingRequirementsResultResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuForecastTimeSeriesResult.md b/build/docs/BuForecastTimeSeriesResult.md index 66cea152d..8ed4a51ec 100644 --- a/build/docs/BuForecastTimeSeriesResult.md +++ b/build/docs/BuForecastTimeSeriesResult.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuFullDayTimeOffMarker.md b/build/docs/BuFullDayTimeOffMarker.md index 7d9d60481..8fdf07ee1 100644 --- a/build/docs/BuFullDayTimeOffMarker.md +++ b/build/docs/BuFullDayTimeOffMarker.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuGenerateScheduleRequest.md b/build/docs/BuGenerateScheduleRequest.md index 9295aefa1..faf578c92 100644 --- a/build/docs/BuGenerateScheduleRequest.md +++ b/build/docs/BuGenerateScheduleRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuGetCurrentAgentScheduleRequest.md b/build/docs/BuGetCurrentAgentScheduleRequest.md index dd3d9f9fa..cebacba93 100644 --- a/build/docs/BuGetCurrentAgentScheduleRequest.md +++ b/build/docs/BuGetCurrentAgentScheduleRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuHeadcountForecast.md b/build/docs/BuHeadcountForecast.md index a0e3765bd..3692126d3 100644 --- a/build/docs/BuHeadcountForecast.md +++ b/build/docs/BuHeadcountForecast.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuHeadcountForecastResponse.md b/build/docs/BuHeadcountForecastResponse.md index a74ad39cc..46f158417 100644 --- a/build/docs/BuHeadcountForecastResponse.md +++ b/build/docs/BuHeadcountForecastResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuImportAgentScheduleUploadSchema.md b/build/docs/BuImportAgentScheduleUploadSchema.md index 525c0d1b4..6d7f9fff6 100644 --- a/build/docs/BuImportAgentScheduleUploadSchema.md +++ b/build/docs/BuImportAgentScheduleUploadSchema.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuImportShortTermForecastSchema.md b/build/docs/BuImportShortTermForecastSchema.md index b08d0dce4..206a3491c 100644 --- a/build/docs/BuImportShortTermForecastSchema.md +++ b/build/docs/BuImportShortTermForecastSchema.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuIntradayDataGroup.md b/build/docs/BuIntradayDataGroup.md index 907bf1767..09334f5d5 100644 --- a/build/docs/BuIntradayDataGroup.md +++ b/build/docs/BuIntradayDataGroup.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuIntradayForecastData.md b/build/docs/BuIntradayForecastData.md index c66649cbe..e4c516817 100644 --- a/build/docs/BuIntradayForecastData.md +++ b/build/docs/BuIntradayForecastData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuIntradayResponse.md b/build/docs/BuIntradayResponse.md index 0ac34b927..08aba22d7 100644 --- a/build/docs/BuIntradayResponse.md +++ b/build/docs/BuIntradayResponse.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuIntradayScheduleData.md b/build/docs/BuIntradayScheduleData.md index 28affd2ce..a25f826ad 100644 --- a/build/docs/BuIntradayScheduleData.md +++ b/build/docs/BuIntradayScheduleData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuListAlternativeShiftTradesResponse.md b/build/docs/BuListAlternativeShiftTradesResponse.md index f3db72f4e..8492ca1ca 100644 --- a/build/docs/BuListAlternativeShiftTradesResponse.md +++ b/build/docs/BuListAlternativeShiftTradesResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuManagementUnitScheduleSummary.md b/build/docs/BuManagementUnitScheduleSummary.md index 24bb16e00..edc26e648 100644 --- a/build/docs/BuManagementUnitScheduleSummary.md +++ b/build/docs/BuManagementUnitScheduleSummary.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuNotificationSettingsRequest.md b/build/docs/BuNotificationSettingsRequest.md index 0c2f52a67..8d2cdc37b 100644 --- a/build/docs/BuNotificationSettingsRequest.md +++ b/build/docs/BuNotificationSettingsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuNotificationSettingsResponse.md b/build/docs/BuNotificationSettingsResponse.md index da366e7e7..4568833aa 100644 --- a/build/docs/BuNotificationSettingsResponse.md +++ b/build/docs/BuNotificationSettingsResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuPlanningGroupHeadcountForecast.md b/build/docs/BuPlanningGroupHeadcountForecast.md index 8bcf6d5fc..69c9e6905 100644 --- a/build/docs/BuPlanningGroupHeadcountForecast.md +++ b/build/docs/BuPlanningGroupHeadcountForecast.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuQueryAdherenceExplanationsRequest.md b/build/docs/BuQueryAdherenceExplanationsRequest.md index 39caa8528..ccb8f3c0d 100644 --- a/build/docs/BuQueryAdherenceExplanationsRequest.md +++ b/build/docs/BuQueryAdherenceExplanationsRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuQueryAdherenceExplanationsResponse.md b/build/docs/BuQueryAdherenceExplanationsResponse.md index 8c1460191..b58acf3bb 100644 --- a/build/docs/BuQueryAdherenceExplanationsResponse.md +++ b/build/docs/BuQueryAdherenceExplanationsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuQueryAgentSchedulesRequest.md b/build/docs/BuQueryAgentSchedulesRequest.md index 517eb9adb..a2fc8477a 100644 --- a/build/docs/BuQueryAgentSchedulesRequest.md +++ b/build/docs/BuQueryAgentSchedulesRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuRescheduleAgentScheduleResult.md b/build/docs/BuRescheduleAgentScheduleResult.md index 8e5e09bbd..a8d3e10a4 100644 --- a/build/docs/BuRescheduleAgentScheduleResult.md +++ b/build/docs/BuRescheduleAgentScheduleResult.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuRescheduleRequest.md b/build/docs/BuRescheduleRequest.md index c0e55cd4c..23209b5ce 100644 --- a/build/docs/BuRescheduleRequest.md +++ b/build/docs/BuRescheduleRequest.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuRescheduleResult.md b/build/docs/BuRescheduleResult.md index 2f878c2fc..5e27c7a50 100644 --- a/build/docs/BuRescheduleResult.md +++ b/build/docs/BuRescheduleResult.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleListItem.md b/build/docs/BuScheduleListItem.md index 198e678a7..aefad33f7 100644 --- a/build/docs/BuScheduleListItem.md +++ b/build/docs/BuScheduleListItem.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleListing.md b/build/docs/BuScheduleListing.md index 0b0a5160c..84230934f 100644 --- a/build/docs/BuScheduleListing.md +++ b/build/docs/BuScheduleListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleMetadata.md b/build/docs/BuScheduleMetadata.md index 80b5d2f09..e6edd744f 100644 --- a/build/docs/BuScheduleMetadata.md +++ b/build/docs/BuScheduleMetadata.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleNotificationsCategorySettings.md b/build/docs/BuScheduleNotificationsCategorySettings.md index 4a435182b..63dbe2c64 100644 --- a/build/docs/BuScheduleNotificationsCategorySettings.md +++ b/build/docs/BuScheduleNotificationsCategorySettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleNotificationsSettingsRequest.md b/build/docs/BuScheduleNotificationsSettingsRequest.md index 61dbae271..599054e7e 100644 --- a/build/docs/BuScheduleNotificationsSettingsRequest.md +++ b/build/docs/BuScheduleNotificationsSettingsRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleNotificationsSettingsResponse.md b/build/docs/BuScheduleNotificationsSettingsResponse.md index 684ed1c93..890a409c2 100644 --- a/build/docs/BuScheduleNotificationsSettingsResponse.md +++ b/build/docs/BuScheduleNotificationsSettingsResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleReference.md b/build/docs/BuScheduleReference.md index b5a05421e..c99ef0daf 100644 --- a/build/docs/BuScheduleReference.md +++ b/build/docs/BuScheduleReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleReferenceForMuRoute.md b/build/docs/BuScheduleReferenceForMuRoute.md index 04441ebef..b4b772c29 100644 --- a/build/docs/BuScheduleReferenceForMuRoute.md +++ b/build/docs/BuScheduleReferenceForMuRoute.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleRun.md b/build/docs/BuScheduleRun.md index d272667dd..11e55c18d 100644 --- a/build/docs/BuScheduleRun.md +++ b/build/docs/BuScheduleRun.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuScheduleRunListing.md b/build/docs/BuScheduleRunListing.md index ec3171c15..764c05b48 100644 --- a/build/docs/BuScheduleRunListing.md +++ b/build/docs/BuScheduleRunListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuSchedulingSettingsRequest.md b/build/docs/BuSchedulingSettingsRequest.md index 3fc62792d..b87d7cc27 100644 --- a/build/docs/BuSchedulingSettingsRequest.md +++ b/build/docs/BuSchedulingSettingsRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuSchedulingSettingsResponse.md b/build/docs/BuSchedulingSettingsResponse.md index 7a731a197..c8a77c233 100644 --- a/build/docs/BuSchedulingSettingsResponse.md +++ b/build/docs/BuSchedulingSettingsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuSearchAgentSchedulesRequest.md b/build/docs/BuSearchAgentSchedulesRequest.md index 46072eb59..64ef4ba9f 100644 --- a/build/docs/BuSearchAgentSchedulesRequest.md +++ b/build/docs/BuSearchAgentSchedulesRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuServiceLevel.md b/build/docs/BuServiceLevel.md index 0753ec462..837f12b3a 100644 --- a/build/docs/BuServiceLevel.md +++ b/build/docs/BuServiceLevel.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuSetTimeOffLimitValuesRequest.md b/build/docs/BuSetTimeOffLimitValuesRequest.md index 32414bf41..c5eb2a02d 100644 --- a/build/docs/BuSetTimeOffLimitValuesRequest.md +++ b/build/docs/BuSetTimeOffLimitValuesRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuShortTermForecast.md b/build/docs/BuShortTermForecast.md index f030cb543..2e64e08c5 100644 --- a/build/docs/BuShortTermForecast.md +++ b/build/docs/BuShortTermForecast.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuShortTermForecastListItem.md b/build/docs/BuShortTermForecastListItem.md index 91440036b..cd0194fcd 100644 --- a/build/docs/BuShortTermForecastListItem.md +++ b/build/docs/BuShortTermForecastListItem.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuShortTermForecastListing.md b/build/docs/BuShortTermForecastListing.md index 5add79808..b951c8b47 100644 --- a/build/docs/BuShortTermForecastListing.md +++ b/build/docs/BuShortTermForecastListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuShortTermForecastReference.md b/build/docs/BuShortTermForecastReference.md index d6c77d868..ae57ffbea 100644 --- a/build/docs/BuShortTermForecastReference.md +++ b/build/docs/BuShortTermForecastReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuShortTermForecastWeekReference.md b/build/docs/BuShortTermForecastWeekReference.md index 1047ca00c..fd409938c 100644 --- a/build/docs/BuShortTermForecastWeekReference.md +++ b/build/docs/BuShortTermForecastWeekReference.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuShortTermForecastingSettings.md b/build/docs/BuShortTermForecastingSettings.md index 580d6f48d..eab14b481 100644 --- a/build/docs/BuShortTermForecastingSettings.md +++ b/build/docs/BuShortTermForecastingSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuTimeOffLimitListing.md b/build/docs/BuTimeOffLimitListing.md index 51be899ca..e87a670f9 100644 --- a/build/docs/BuTimeOffLimitListing.md +++ b/build/docs/BuTimeOffLimitListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuTimeOffLimitRange.md b/build/docs/BuTimeOffLimitRange.md index 2ad71f29a..6c1a263ce 100644 --- a/build/docs/BuTimeOffLimitRange.md +++ b/build/docs/BuTimeOffLimitRange.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuTimeOffLimitReference.md b/build/docs/BuTimeOffLimitReference.md index 7807534cc..25ad99e6b 100644 --- a/build/docs/BuTimeOffLimitReference.md +++ b/build/docs/BuTimeOffLimitReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuTimeOffLimitResponse.md b/build/docs/BuTimeOffLimitResponse.md index a8b189304..d9ca7d67b 100644 --- a/build/docs/BuTimeOffLimitResponse.md +++ b/build/docs/BuTimeOffLimitResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuTimeOffLimitValueRange.md b/build/docs/BuTimeOffLimitValueRange.md index 51100b9b0..d9488c456 100644 --- a/build/docs/BuTimeOffLimitValueRange.md +++ b/build/docs/BuTimeOffLimitValueRange.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuTimeOffLimitValuesResponse.md b/build/docs/BuTimeOffLimitValuesResponse.md index 4db8b66e2..5f90cd757 100644 --- a/build/docs/BuTimeOffLimitValuesResponse.md +++ b/build/docs/BuTimeOffLimitValuesResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuTimeOffPlanListing.md b/build/docs/BuTimeOffPlanListing.md index c55cd6c37..fd2a07959 100644 --- a/build/docs/BuTimeOffPlanListing.md +++ b/build/docs/BuTimeOffPlanListing.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuTimeOffPlanResponse.md b/build/docs/BuTimeOffPlanResponse.md index b9895b667..86de02eb6 100644 --- a/build/docs/BuTimeOffPlanResponse.md +++ b/build/docs/BuTimeOffPlanResponse.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuUpdateAgentScheduleShift.md b/build/docs/BuUpdateAgentScheduleShift.md index 24789b1e9..b1480ccbf 100644 --- a/build/docs/BuUpdateAgentScheduleShift.md +++ b/build/docs/BuUpdateAgentScheduleShift.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuUpdateAgentScheduleUploadSchema.md b/build/docs/BuUpdateAgentScheduleUploadSchema.md index 82557ff67..016af2c38 100644 --- a/build/docs/BuUpdateAgentScheduleUploadSchema.md +++ b/build/docs/BuUpdateAgentScheduleUploadSchema.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BuUpdateTimeOffPlanRequest.md b/build/docs/BuUpdateTimeOffPlanRequest.md index d1aa9497e..230d6991c 100644 --- a/build/docs/BuUpdateTimeOffPlanRequest.md +++ b/build/docs/BuUpdateTimeOffPlanRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkCallbackDisconnectRequest.md b/build/docs/BulkCallbackDisconnectRequest.md index c28fdb269..71473e21e 100644 --- a/build/docs/BulkCallbackDisconnectRequest.md +++ b/build/docs/BulkCallbackDisconnectRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkCallbackPatchRequest.md b/build/docs/BulkCallbackPatchRequest.md index f75c51ade..5236f3c73 100644 --- a/build/docs/BulkCallbackPatchRequest.md +++ b/build/docs/BulkCallbackPatchRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkCallbackPatchResponse.md b/build/docs/BulkCallbackPatchResponse.md index 0b310a56e..c416ea83e 100644 --- a/build/docs/BulkCallbackPatchResponse.md +++ b/build/docs/BulkCallbackPatchResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkContactsRequest.md b/build/docs/BulkContactsRequest.md index 703f75ca7..66b093a78 100644 --- a/build/docs/BulkContactsRequest.md +++ b/build/docs/BulkContactsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkContactsResponse.md b/build/docs/BulkContactsResponse.md index 71ceefec8..944d80395 100644 --- a/build/docs/BulkContactsResponse.md +++ b/build/docs/BulkContactsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkDeleteResponse.md b/build/docs/BulkDeleteResponse.md index b5fd73f48..1bb1a5141 100644 --- a/build/docs/BulkDeleteResponse.md +++ b/build/docs/BulkDeleteResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkError.md b/build/docs/BulkError.md index 7f7537abe..b96956128 100644 --- a/build/docs/BulkError.md +++ b/build/docs/BulkError.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkErrorDetail.md b/build/docs/BulkErrorDetail.md index 9fc661470..137007e60 100644 --- a/build/docs/BulkErrorDetail.md +++ b/build/docs/BulkErrorDetail.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkErrorEntity.md b/build/docs/BulkErrorEntity.md index d33fe27fc..1b25f834b 100644 --- a/build/docs/BulkErrorEntity.md +++ b/build/docs/BulkErrorEntity.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkErrorExternalContact.md b/build/docs/BulkErrorExternalContact.md index 9ad36f0b7..5282bb8e8 100644 --- a/build/docs/BulkErrorExternalContact.md +++ b/build/docs/BulkErrorExternalContact.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkErrorExternalOrganization.md b/build/docs/BulkErrorExternalOrganization.md index 86c0c11bb..0e3e38e32 100644 --- a/build/docs/BulkErrorExternalOrganization.md +++ b/build/docs/BulkErrorExternalOrganization.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkErrorNote.md b/build/docs/BulkErrorNote.md index b53ba7eb5..1474f19aa 100644 --- a/build/docs/BulkErrorNote.md +++ b/build/docs/BulkErrorNote.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkErrorRelationship.md b/build/docs/BulkErrorRelationship.md index f34852885..b26d49eba 100644 --- a/build/docs/BulkErrorRelationship.md +++ b/build/docs/BulkErrorRelationship.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkFetchContactsResponse.md b/build/docs/BulkFetchContactsResponse.md index 8cb71cde3..ff24ff0b1 100644 --- a/build/docs/BulkFetchContactsResponse.md +++ b/build/docs/BulkFetchContactsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkFetchNotesResponse.md b/build/docs/BulkFetchNotesResponse.md index 10aefdb7f..ea68d1ad6 100644 --- a/build/docs/BulkFetchNotesResponse.md +++ b/build/docs/BulkFetchNotesResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkFetchOrganizationsResponse.md b/build/docs/BulkFetchOrganizationsResponse.md index 9678a0ad3..e7c8c207e 100644 --- a/build/docs/BulkFetchOrganizationsResponse.md +++ b/build/docs/BulkFetchOrganizationsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkFetchRelationshipsResponse.md b/build/docs/BulkFetchRelationshipsResponse.md index f076fd96c..680580eaa 100644 --- a/build/docs/BulkFetchRelationshipsResponse.md +++ b/build/docs/BulkFetchRelationshipsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkIdsRequest.md b/build/docs/BulkIdsRequest.md index b82cef92c..fa544b5af 100644 --- a/build/docs/BulkIdsRequest.md +++ b/build/docs/BulkIdsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkNotesRequest.md b/build/docs/BulkNotesRequest.md index 860294cdd..d9bc20b24 100644 --- a/build/docs/BulkNotesRequest.md +++ b/build/docs/BulkNotesRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkNotesResponse.md b/build/docs/BulkNotesResponse.md index debab060c..26bb03944 100644 --- a/build/docs/BulkNotesResponse.md +++ b/build/docs/BulkNotesResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkOrganizationsRequest.md b/build/docs/BulkOrganizationsRequest.md index 2a763ee28..3930f3a52 100644 --- a/build/docs/BulkOrganizationsRequest.md +++ b/build/docs/BulkOrganizationsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkOrganizationsResponse.md b/build/docs/BulkOrganizationsResponse.md index d0c375269..7f5841abb 100644 --- a/build/docs/BulkOrganizationsResponse.md +++ b/build/docs/BulkOrganizationsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkRelationshipsRequest.md b/build/docs/BulkRelationshipsRequest.md index 353056dd9..3132e4d8d 100644 --- a/build/docs/BulkRelationshipsRequest.md +++ b/build/docs/BulkRelationshipsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkRelationshipsResponse.md b/build/docs/BulkRelationshipsResponse.md index 8adb05e4d..1c52419d1 100644 --- a/build/docs/BulkRelationshipsResponse.md +++ b/build/docs/BulkRelationshipsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponse.md b/build/docs/BulkResponse.md index 5ed75448e..c54c66a4c 100644 --- a/build/docs/BulkResponse.md +++ b/build/docs/BulkResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultExternalContactEntity.md b/build/docs/BulkResponseResultExternalContactEntity.md index bfd697b81..94c992ef1 100644 --- a/build/docs/BulkResponseResultExternalContactEntity.md +++ b/build/docs/BulkResponseResultExternalContactEntity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultExternalContactExternalContact.md b/build/docs/BulkResponseResultExternalContactExternalContact.md index 8816f0add..524873ae5 100644 --- a/build/docs/BulkResponseResultExternalContactExternalContact.md +++ b/build/docs/BulkResponseResultExternalContactExternalContact.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultExternalOrganizationEntity.md b/build/docs/BulkResponseResultExternalOrganizationEntity.md index d617e04d5..f5168387e 100644 --- a/build/docs/BulkResponseResultExternalOrganizationEntity.md +++ b/build/docs/BulkResponseResultExternalOrganizationEntity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultExternalOrganizationExternalOrganization.md b/build/docs/BulkResponseResultExternalOrganizationExternalOrganization.md index 2da1539b9..5b1356f8c 100644 --- a/build/docs/BulkResponseResultExternalOrganizationExternalOrganization.md +++ b/build/docs/BulkResponseResultExternalOrganizationExternalOrganization.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultNoteEntity.md b/build/docs/BulkResponseResultNoteEntity.md index f2bfff5a3..e7588863b 100644 --- a/build/docs/BulkResponseResultNoteEntity.md +++ b/build/docs/BulkResponseResultNoteEntity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultNoteNote.md b/build/docs/BulkResponseResultNoteNote.md index c51c0706d..05d716ebd 100644 --- a/build/docs/BulkResponseResultNoteNote.md +++ b/build/docs/BulkResponseResultNoteNote.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultRelationshipEntity.md b/build/docs/BulkResponseResultRelationshipEntity.md index 82094fe15..4f8fdfd49 100644 --- a/build/docs/BulkResponseResultRelationshipEntity.md +++ b/build/docs/BulkResponseResultRelationshipEntity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultRelationshipRelationship.md b/build/docs/BulkResponseResultRelationshipRelationship.md index 3350d4081..b9e3bbdc6 100644 --- a/build/docs/BulkResponseResultRelationshipRelationship.md +++ b/build/docs/BulkResponseResultRelationshipRelationship.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResponseResultVoidEntity.md b/build/docs/BulkResponseResultVoidEntity.md index 342c711cf..84cecfca7 100644 --- a/build/docs/BulkResponseResultVoidEntity.md +++ b/build/docs/BulkResponseResultVoidEntity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkResult.md b/build/docs/BulkResult.md index bab5c7cb9..1d1a8394e 100644 --- a/build/docs/BulkResult.md +++ b/build/docs/BulkResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkShiftTradeStateUpdateRequest.md b/build/docs/BulkShiftTradeStateUpdateRequest.md index 555df3e30..1b5d54658 100644 --- a/build/docs/BulkShiftTradeStateUpdateRequest.md +++ b/build/docs/BulkShiftTradeStateUpdateRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkUpdateShiftTradeStateRequestItem.md b/build/docs/BulkUpdateShiftTradeStateRequestItem.md index a3c841d7e..a15cfca8b 100644 --- a/build/docs/BulkUpdateShiftTradeStateRequestItem.md +++ b/build/docs/BulkUpdateShiftTradeStateRequestItem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkUpdateShiftTradeStateResponse.md b/build/docs/BulkUpdateShiftTradeStateResponse.md index c7b78de24..e4ffcccda 100644 --- a/build/docs/BulkUpdateShiftTradeStateResponse.md +++ b/build/docs/BulkUpdateShiftTradeStateResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkUpdateShiftTradeStateResult.md b/build/docs/BulkUpdateShiftTradeStateResult.md index 138ebb916..4c14ed806 100644 --- a/build/docs/BulkUpdateShiftTradeStateResult.md +++ b/build/docs/BulkUpdateShiftTradeStateResult.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BulkUpdateShiftTradeStateResultItem.md b/build/docs/BulkUpdateShiftTradeStateResultItem.md index 8bd1d3b94..ee08c4c51 100644 --- a/build/docs/BulkUpdateShiftTradeStateResultItem.md +++ b/build/docs/BulkUpdateShiftTradeStateResultItem.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Bullseye.md b/build/docs/Bullseye.md index d47397411..d2357afd3 100644 --- a/build/docs/Bullseye.md +++ b/build/docs/Bullseye.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BusinessUnitActivityCode.md b/build/docs/BusinessUnitActivityCode.md index 6d79ad438..a51c985fa 100644 --- a/build/docs/BusinessUnitActivityCode.md +++ b/build/docs/BusinessUnitActivityCode.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BusinessUnitActivityCodeListing.md b/build/docs/BusinessUnitActivityCodeListing.md index 78dfb2068..0ddf63742 100644 --- a/build/docs/BusinessUnitActivityCodeListing.md +++ b/build/docs/BusinessUnitActivityCodeListing.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BusinessUnitListItem.md b/build/docs/BusinessUnitListItem.md index 9f86f02b7..c44acae60 100644 --- a/build/docs/BusinessUnitListItem.md +++ b/build/docs/BusinessUnitListItem.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BusinessUnitListing.md b/build/docs/BusinessUnitListing.md index 4322ec84a..0284d6c1d 100644 --- a/build/docs/BusinessUnitListing.md +++ b/build/docs/BusinessUnitListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BusinessUnitReference.md b/build/docs/BusinessUnitReference.md index 0cd8b3623..47b0a11e2 100644 --- a/build/docs/BusinessUnitReference.md +++ b/build/docs/BusinessUnitReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BusinessUnitResponse.md b/build/docs/BusinessUnitResponse.md index ff61157fc..51d98ebc4 100644 --- a/build/docs/BusinessUnitResponse.md +++ b/build/docs/BusinessUnitResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/BusinessUnitSettingsResponse.md b/build/docs/BusinessUnitSettingsResponse.md index 3506a6b11..ba8dab6b9 100644 --- a/build/docs/BusinessUnitSettingsResponse.md +++ b/build/docs/BusinessUnitSettingsResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Button.md b/build/docs/Button.md index 22e3e1cca..02a9df6f5 100644 --- a/build/docs/Button.md +++ b/build/docs/Button.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ButtonComponent.md b/build/docs/ButtonComponent.md index d65b0c4bf..c260e8841 100644 --- a/build/docs/ButtonComponent.md +++ b/build/docs/ButtonComponent.md @@ -12,4 +12,4 @@ Structured template button object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ButtonResponse.md b/build/docs/ButtonResponse.md index 4e17774fd..aef737966 100644 --- a/build/docs/ButtonResponse.md +++ b/build/docs/ButtonResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CachedMediaItem.md b/build/docs/CachedMediaItem.md index 6b694e4e3..ae9625a27 100644 --- a/build/docs/CachedMediaItem.md +++ b/build/docs/CachedMediaItem.md @@ -18,4 +18,4 @@ Defines an external media that has been ingested and cached by Genesys Cloud for -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CachedMediaItemEntityListing.md b/build/docs/CachedMediaItemEntityListing.md index 351219140..6b58fe2f6 100644 --- a/build/docs/CachedMediaItemEntityListing.md +++ b/build/docs/CachedMediaItemEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CalendarUrlResponse.md b/build/docs/CalendarUrlResponse.md index f66a3d698..85e63d4e4 100644 --- a/build/docs/CalendarUrlResponse.md +++ b/build/docs/CalendarUrlResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Calibration.md b/build/docs/Calibration.md index 1f1f2fa5f..7393d74b8 100644 --- a/build/docs/Calibration.md +++ b/build/docs/Calibration.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CalibrationAssignment.md b/build/docs/CalibrationAssignment.md index d31f45727..10a080a8a 100644 --- a/build/docs/CalibrationAssignment.md +++ b/build/docs/CalibrationAssignment.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CalibrationCreate.md b/build/docs/CalibrationCreate.md index a7f41dce0..828948727 100644 --- a/build/docs/CalibrationCreate.md +++ b/build/docs/CalibrationCreate.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CalibrationEntityListing.md b/build/docs/CalibrationEntityListing.md index 208983d1f..104ba2185 100644 --- a/build/docs/CalibrationEntityListing.md +++ b/build/docs/CalibrationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Call.md b/build/docs/Call.md index 10c3b6a62..7464b7e61 100644 --- a/build/docs/Call.md +++ b/build/docs/Call.md @@ -42,4 +42,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallBasic.md b/build/docs/CallBasic.md index 6e8ee268d..dfe11366a 100644 --- a/build/docs/CallBasic.md +++ b/build/docs/CallBasic.md @@ -42,4 +42,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallCommand.md b/build/docs/CallCommand.md index 0bf0b2afd..fe1919c96 100644 --- a/build/docs/CallCommand.md +++ b/build/docs/CallCommand.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallConversation.md b/build/docs/CallConversation.md index b9dfa7e44..db619e670 100644 --- a/build/docs/CallConversation.md +++ b/build/docs/CallConversation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallConversationEntityListing.md b/build/docs/CallConversationEntityListing.md index 193f0fe52..5d73fc0ae 100644 --- a/build/docs/CallConversationEntityListing.md +++ b/build/docs/CallConversationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallForwarding.md b/build/docs/CallForwarding.md index bc8aae666..ed4da22c6 100644 --- a/build/docs/CallForwarding.md +++ b/build/docs/CallForwarding.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallForwardingEventCall.md b/build/docs/CallForwardingEventCall.md index 619b88a7b..f79b6a803 100644 --- a/build/docs/CallForwardingEventCall.md +++ b/build/docs/CallForwardingEventCall.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallForwardingEventCallForwarding.md b/build/docs/CallForwardingEventCallForwarding.md index 8cec23974..bf62c9014 100644 --- a/build/docs/CallForwardingEventCallForwarding.md +++ b/build/docs/CallForwardingEventCallForwarding.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallForwardingEventTarget.md b/build/docs/CallForwardingEventTarget.md index 6bbe86eba..286e61112 100644 --- a/build/docs/CallForwardingEventTarget.md +++ b/build/docs/CallForwardingEventTarget.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallForwardingEventUser.md b/build/docs/CallForwardingEventUser.md index 84833b5af..667619265 100644 --- a/build/docs/CallForwardingEventUser.md +++ b/build/docs/CallForwardingEventUser.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallHistoryConversation.md b/build/docs/CallHistoryConversation.md index bb73816df..91a9bd675 100644 --- a/build/docs/CallHistoryConversation.md +++ b/build/docs/CallHistoryConversation.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallHistoryConversationEntityListing.md b/build/docs/CallHistoryConversationEntityListing.md index 6f50355b7..4dc1e2278 100644 --- a/build/docs/CallHistoryConversationEntityListing.md +++ b/build/docs/CallHistoryConversationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallHistoryParticipant.md b/build/docs/CallHistoryParticipant.md index ad92a58a9..469404bff 100644 --- a/build/docs/CallHistoryParticipant.md +++ b/build/docs/CallHistoryParticipant.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallMediaParticipant.md b/build/docs/CallMediaParticipant.md index c42b7c0d1..6d187bc4a 100644 --- a/build/docs/CallMediaParticipant.md +++ b/build/docs/CallMediaParticipant.md @@ -61,4 +61,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallMediaPolicy.md b/build/docs/CallMediaPolicy.md index d28722b6a..3e386ee94 100644 --- a/build/docs/CallMediaPolicy.md +++ b/build/docs/CallMediaPolicy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallMediaPolicyConditions.md b/build/docs/CallMediaPolicyConditions.md index 4e09ee384..47fadd946 100644 --- a/build/docs/CallMediaPolicyConditions.md +++ b/build/docs/CallMediaPolicyConditions.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallRecord.md b/build/docs/CallRecord.md index 7acfe32c6..c36dee657 100644 --- a/build/docs/CallRecord.md +++ b/build/docs/CallRecord.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallRoute.md b/build/docs/CallRoute.md index 05b0be47d..ac1b25c43 100644 --- a/build/docs/CallRoute.md +++ b/build/docs/CallRoute.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallTarget.md b/build/docs/CallTarget.md index 61f60cf34..1bcd9a662 100644 --- a/build/docs/CallTarget.md +++ b/build/docs/CallTarget.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallToAction.md b/build/docs/CallToAction.md index a24d1e5c3..6d051ff6f 100644 --- a/build/docs/CallToAction.md +++ b/build/docs/CallToAction.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallableContactsDiagnostic.md b/build/docs/CallableContactsDiagnostic.md index 56add756e..2c5429d05 100644 --- a/build/docs/CallableContactsDiagnostic.md +++ b/build/docs/CallableContactsDiagnostic.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallableTime.md b/build/docs/CallableTime.md index f1a5e904b..118633d40 100644 --- a/build/docs/CallableTime.md +++ b/build/docs/CallableTime.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallableTimeSet.md b/build/docs/CallableTimeSet.md index af7ebec0e..686c626b1 100644 --- a/build/docs/CallableTimeSet.md +++ b/build/docs/CallableTimeSet.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallableTimeSetEntityListing.md b/build/docs/CallableTimeSetEntityListing.md index c3a2aaee3..b2dc802be 100644 --- a/build/docs/CallableTimeSetEntityListing.md +++ b/build/docs/CallableTimeSetEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallableWindow.md b/build/docs/CallableWindow.md index b0ebf95f0..3868c7051 100644 --- a/build/docs/CallableWindow.md +++ b/build/docs/CallableWindow.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Callback.md b/build/docs/Callback.md index b6daaeb05..e381f8296 100644 --- a/build/docs/Callback.md +++ b/build/docs/Callback.md @@ -38,4 +38,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallbackBasic.md b/build/docs/CallbackBasic.md index 4244ad91c..bb962a23d 100644 --- a/build/docs/CallbackBasic.md +++ b/build/docs/CallbackBasic.md @@ -38,4 +38,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallbackConversation.md b/build/docs/CallbackConversation.md index 26bf95be3..f67d50e53 100644 --- a/build/docs/CallbackConversation.md +++ b/build/docs/CallbackConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallbackConversationEntityListing.md b/build/docs/CallbackConversationEntityListing.md index 8b2626b18..c3d5cccd5 100644 --- a/build/docs/CallbackConversationEntityListing.md +++ b/build/docs/CallbackConversationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallbackDisconnectIdentifier.md b/build/docs/CallbackDisconnectIdentifier.md index 9975ef094..7cd8106c3 100644 --- a/build/docs/CallbackDisconnectIdentifier.md +++ b/build/docs/CallbackDisconnectIdentifier.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallbackIdentifier.md b/build/docs/CallbackIdentifier.md index 72b4fe7fa..70abe1e08 100644 --- a/build/docs/CallbackIdentifier.md +++ b/build/docs/CallbackIdentifier.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallbackMediaParticipant.md b/build/docs/CallbackMediaParticipant.md index 555b26360..6a2573916 100644 --- a/build/docs/CallbackMediaParticipant.md +++ b/build/docs/CallbackMediaParticipant.md @@ -53,4 +53,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CallbackMediaSettings.md b/build/docs/CallbackMediaSettings.md index f33ad5722..5a9cc8a02 100644 --- a/build/docs/CallbackMediaSettings.md +++ b/build/docs/CallbackMediaSettings.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Callheader.md b/build/docs/Callheader.md index 363dd8440..cd57e263f 100644 --- a/build/docs/Callheader.md +++ b/build/docs/Callheader.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Callmessage.md b/build/docs/Callmessage.md index 2d292f482..7e32afbe8 100644 --- a/build/docs/Callmessage.md +++ b/build/docs/Callmessage.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Campaign.md b/build/docs/Campaign.md index 84bafaaa1..569eecea8 100644 --- a/build/docs/Campaign.md +++ b/build/docs/Campaign.md @@ -48,4 +48,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignBusinessCategoryMetrics.md b/build/docs/CampaignBusinessCategoryMetrics.md index 9fdfc5982..10074bcaa 100644 --- a/build/docs/CampaignBusinessCategoryMetrics.md +++ b/build/docs/CampaignBusinessCategoryMetrics.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignDiagnostics.md b/build/docs/CampaignDiagnostics.md index 1c6ed4842..250d87fd0 100644 --- a/build/docs/CampaignDiagnostics.md +++ b/build/docs/CampaignDiagnostics.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignDivisionView.md b/build/docs/CampaignDivisionView.md index 607374ad4..e1c2057e0 100644 --- a/build/docs/CampaignDivisionView.md +++ b/build/docs/CampaignDivisionView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignDivisionViewListing.md b/build/docs/CampaignDivisionViewListing.md index a5537ee69..7030c1e53 100644 --- a/build/docs/CampaignDivisionViewListing.md +++ b/build/docs/CampaignDivisionViewListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignEntityListing.md b/build/docs/CampaignEntityListing.md index e9ebf25f5..f22c526f3 100644 --- a/build/docs/CampaignEntityListing.md +++ b/build/docs/CampaignEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignInteraction.md b/build/docs/CampaignInteraction.md index b268de22c..28aebd00f 100644 --- a/build/docs/CampaignInteraction.md +++ b/build/docs/CampaignInteraction.md @@ -30,4 +30,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignInteractions.md b/build/docs/CampaignInteractions.md index 8b284dad7..a2ae1befe 100644 --- a/build/docs/CampaignInteractions.md +++ b/build/docs/CampaignInteractions.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignLinesUtilization.md b/build/docs/CampaignLinesUtilization.md index 5b7bfa23c..fa24e71bb 100644 --- a/build/docs/CampaignLinesUtilization.md +++ b/build/docs/CampaignLinesUtilization.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignOutboundLinesAllocation.md b/build/docs/CampaignOutboundLinesAllocation.md index a5941e523..1eba1d7e0 100644 --- a/build/docs/CampaignOutboundLinesAllocation.md +++ b/build/docs/CampaignOutboundLinesAllocation.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignOutboundLinesDistribution.md b/build/docs/CampaignOutboundLinesDistribution.md index 478cb411d..37095e623 100644 --- a/build/docs/CampaignOutboundLinesDistribution.md +++ b/build/docs/CampaignOutboundLinesDistribution.md @@ -17,4 +17,4 @@ Lines distribution information or Campaign's Edge Group or Site -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignOutboundLinesReservation.md b/build/docs/CampaignOutboundLinesReservation.md index 3dea75c60..2ae5d210d 100644 --- a/build/docs/CampaignOutboundLinesReservation.md +++ b/build/docs/CampaignOutboundLinesReservation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignPatchRequest.md b/build/docs/CampaignPatchRequest.md index b022df1d3..1630e7f04 100644 --- a/build/docs/CampaignPatchRequest.md +++ b/build/docs/CampaignPatchRequest.md @@ -15,4 +15,4 @@ Campaign patch request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignProgress.md b/build/docs/CampaignProgress.md index e7c3cdb99..804592566 100644 --- a/build/docs/CampaignProgress.md +++ b/build/docs/CampaignProgress.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRule.md b/build/docs/CampaignRule.md index c45f73bab..837f9f6fb 100644 --- a/build/docs/CampaignRule.md +++ b/build/docs/CampaignRule.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleAction.md b/build/docs/CampaignRuleAction.md index a690e511a..e6c7b0fab 100644 --- a/build/docs/CampaignRuleAction.md +++ b/build/docs/CampaignRuleAction.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleActionEntities.md b/build/docs/CampaignRuleActionEntities.md index a45920d98..abaab5fec 100644 --- a/build/docs/CampaignRuleActionEntities.md +++ b/build/docs/CampaignRuleActionEntities.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleCondition.md b/build/docs/CampaignRuleCondition.md index 8e5ccb357..242d84f62 100644 --- a/build/docs/CampaignRuleCondition.md +++ b/build/docs/CampaignRuleCondition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleConditionGroup.md b/build/docs/CampaignRuleConditionGroup.md index 1608b71e7..21394aea6 100644 --- a/build/docs/CampaignRuleConditionGroup.md +++ b/build/docs/CampaignRuleConditionGroup.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleEntities.md b/build/docs/CampaignRuleEntities.md index fc841489e..913b5d507 100644 --- a/build/docs/CampaignRuleEntities.md +++ b/build/docs/CampaignRuleEntities.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleEntityListing.md b/build/docs/CampaignRuleEntityListing.md index db78e90e1..1ef8dd5c3 100644 --- a/build/docs/CampaignRuleEntityListing.md +++ b/build/docs/CampaignRuleEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleExecutionSettings.md b/build/docs/CampaignRuleExecutionSettings.md index 85c6a55f2..ff0ccdd56 100644 --- a/build/docs/CampaignRuleExecutionSettings.md +++ b/build/docs/CampaignRuleExecutionSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleParameters.md b/build/docs/CampaignRuleParameters.md index 8b005b010..3ce2b589e 100644 --- a/build/docs/CampaignRuleParameters.md +++ b/build/docs/CampaignRuleParameters.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleWarning.md b/build/docs/CampaignRuleWarning.md index 344d7f693..66805e3ef 100644 --- a/build/docs/CampaignRuleWarning.md +++ b/build/docs/CampaignRuleWarning.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignRuleWarningParameters.md b/build/docs/CampaignRuleWarningParameters.md index 5292fd042..bd1207da7 100644 --- a/build/docs/CampaignRuleWarningParameters.md +++ b/build/docs/CampaignRuleWarningParameters.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignSchedule.md b/build/docs/CampaignSchedule.md index fde1a8466..ce7e4491f 100644 --- a/build/docs/CampaignSchedule.md +++ b/build/docs/CampaignSchedule.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignSequence.md b/build/docs/CampaignSequence.md index 71e01a9d5..f04f2bb62 100644 --- a/build/docs/CampaignSequence.md +++ b/build/docs/CampaignSequence.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignSequenceEntityListing.md b/build/docs/CampaignSequenceEntityListing.md index 9f3d63eaa..6765107cd 100644 --- a/build/docs/CampaignSequenceEntityListing.md +++ b/build/docs/CampaignSequenceEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignSkillStatistics.md b/build/docs/CampaignSkillStatistics.md index 04dca47fd..b431969e6 100644 --- a/build/docs/CampaignSkillStatistics.md +++ b/build/docs/CampaignSkillStatistics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignStats.md b/build/docs/CampaignStats.md index c53a24d4f..0254d7187 100644 --- a/build/docs/CampaignStats.md +++ b/build/docs/CampaignStats.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CampaignTimeSlot.md b/build/docs/CampaignTimeSlot.md index ef81d953c..7d0b017de 100644 --- a/build/docs/CampaignTimeSlot.md +++ b/build/docs/CampaignTimeSlot.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CannedResponseLibraries.md b/build/docs/CannedResponseLibraries.md index 16fecae99..df9b7b712 100644 --- a/build/docs/CannedResponseLibraries.md +++ b/build/docs/CannedResponseLibraries.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Card.md b/build/docs/Card.md index 95eaeb999..88dfb4234 100644 --- a/build/docs/Card.md +++ b/build/docs/Card.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CardAction.md b/build/docs/CardAction.md index 338e272a7..b11e066f8 100644 --- a/build/docs/CardAction.md +++ b/build/docs/CardAction.md @@ -15,4 +15,4 @@ A card action that a user can take. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CarrierServicesAPI.md b/build/docs/CarrierServicesAPI.md index 2a32d617f..6a810ed81 100644 --- a/build/docs/CarrierServicesAPI.md +++ b/build/docs/CarrierServicesAPI.md @@ -107,4 +107,4 @@ CarrierServicesAPI.postCarrierservicesIntegrationsEmergencylocationsMe(body: bod [**EmergencyLocation**](EmergencyLocation) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoriesEntityListing.md b/build/docs/CategoriesEntityListing.md index 76833eacf..dc6cdf642 100644 --- a/build/docs/CategoriesEntityListing.md +++ b/build/docs/CategoriesEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoriesFilter.md b/build/docs/CategoriesFilter.md index 699dde087..3810f333e 100644 --- a/build/docs/CategoriesFilter.md +++ b/build/docs/CategoriesFilter.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Category.md b/build/docs/Category.md index e0c4cfebb..7443a7eaf 100644 --- a/build/docs/Category.md +++ b/build/docs/Category.md @@ -11,4 +11,4 @@ List of available Action categories. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryCreateRequest.md b/build/docs/CategoryCreateRequest.md index ae5cf9b8d..c0d0ddccd 100644 --- a/build/docs/CategoryCreateRequest.md +++ b/build/docs/CategoryCreateRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryEntity.md b/build/docs/CategoryEntity.md index 8ceac5e3e..7b3b290f2 100644 --- a/build/docs/CategoryEntity.md +++ b/build/docs/CategoryEntity.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryEntityListing.md b/build/docs/CategoryEntityListing.md index 99083a8ce..98732d23f 100644 --- a/build/docs/CategoryEntityListing.md +++ b/build/docs/CategoryEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryListing.md b/build/docs/CategoryListing.md index 24f5f590a..f1d02baea 100644 --- a/build/docs/CategoryListing.md +++ b/build/docs/CategoryListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryReference.md b/build/docs/CategoryReference.md index ee529878a..bcb600191 100644 --- a/build/docs/CategoryReference.md +++ b/build/docs/CategoryReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryRequest.md b/build/docs/CategoryRequest.md index ca4319f8f..12b529f0d 100644 --- a/build/docs/CategoryRequest.md +++ b/build/docs/CategoryRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryResponse.md b/build/docs/CategoryResponse.md index 0ebdfd390..1fb6097b4 100644 --- a/build/docs/CategoryResponse.md +++ b/build/docs/CategoryResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryResponseListing.md b/build/docs/CategoryResponseListing.md index b889577a6..2faccbe8c 100644 --- a/build/docs/CategoryResponseListing.md +++ b/build/docs/CategoryResponseListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CategoryUpdateRequest.md b/build/docs/CategoryUpdateRequest.md index fc727cae5..711f980b0 100644 --- a/build/docs/CategoryUpdateRequest.md +++ b/build/docs/CategoryUpdateRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Celebration.md b/build/docs/Celebration.md index a61d9a2fb..654b964b2 100644 --- a/build/docs/Celebration.md +++ b/build/docs/Celebration.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CelebrationStateParam.md b/build/docs/CelebrationStateParam.md index bed0d1aaf..a550023fd 100644 --- a/build/docs/CelebrationStateParam.md +++ b/build/docs/CelebrationStateParam.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Certificate.md b/build/docs/Certificate.md index 56c2007eb..c0f5af6e2 100644 --- a/build/docs/Certificate.md +++ b/build/docs/Certificate.md @@ -11,4 +11,4 @@ Represents a certificate to parse. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CertificateAuthorityEntityListing.md b/build/docs/CertificateAuthorityEntityListing.md index 5f5811ec2..3376cfee7 100644 --- a/build/docs/CertificateAuthorityEntityListing.md +++ b/build/docs/CertificateAuthorityEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CertificateDetails.md b/build/docs/CertificateDetails.md index 7fc76fe75..c1dc77b69 100644 --- a/build/docs/CertificateDetails.md +++ b/build/docs/CertificateDetails.md @@ -17,4 +17,4 @@ Represents the details of a parsed certificate. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChangeMyPasswordRequest.md b/build/docs/ChangeMyPasswordRequest.md index 244aef38f..382321be0 100644 --- a/build/docs/ChangeMyPasswordRequest.md +++ b/build/docs/ChangeMyPasswordRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChangePasswordRequest.md b/build/docs/ChangePasswordRequest.md index 22c449a06..bcc6f1b7a 100644 --- a/build/docs/ChangePasswordRequest.md +++ b/build/docs/ChangePasswordRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Channel.md b/build/docs/Channel.md index dcc688b3d..0a062bf43 100644 --- a/build/docs/Channel.md +++ b/build/docs/Channel.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChannelEntityListing.md b/build/docs/ChannelEntityListing.md index fa66f869d..c50ee8429 100644 --- a/build/docs/ChannelEntityListing.md +++ b/build/docs/ChannelEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChannelTopic.md b/build/docs/ChannelTopic.md index f3d8908df..a9406122a 100644 --- a/build/docs/ChannelTopic.md +++ b/build/docs/ChannelTopic.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChannelTopicEntityListing.md b/build/docs/ChannelTopicEntityListing.md index 03151bd9f..06b5863c8 100644 --- a/build/docs/ChannelTopicEntityListing.md +++ b/build/docs/ChannelTopicEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Chat.md b/build/docs/Chat.md index d628ec5dd..d893f6ce8 100644 --- a/build/docs/Chat.md +++ b/build/docs/Chat.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatAPI.md b/build/docs/ChatAPI.md index ebe9f72b1..7054545e6 100644 --- a/build/docs/ChatAPI.md +++ b/build/docs/ChatAPI.md @@ -1344,4 +1344,4 @@ ChatAPI.putChatsSettings(body: body) { (response, error) in [**ChatSettings**](ChatSettings) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatBadgeTopicBadgeEntity.md b/build/docs/ChatBadgeTopicBadgeEntity.md index 3edc1c366..d07bc04ca 100644 --- a/build/docs/ChatBadgeTopicBadgeEntity.md +++ b/build/docs/ChatBadgeTopicBadgeEntity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatBadgeTopicChatBadge.md b/build/docs/ChatBadgeTopicChatBadge.md index 6bb5dcf41..42211acb5 100644 --- a/build/docs/ChatBadgeTopicChatBadge.md +++ b/build/docs/ChatBadgeTopicChatBadge.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatConversation.md b/build/docs/ChatConversation.md index fa9ae2ebe..d3a86bdec 100644 --- a/build/docs/ChatConversation.md +++ b/build/docs/ChatConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatConversationEntityListing.md b/build/docs/ChatConversationEntityListing.md index e0d2ded72..120079df3 100644 --- a/build/docs/ChatConversationEntityListing.md +++ b/build/docs/ChatConversationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatFavorite.md b/build/docs/ChatFavorite.md index 9f664c851..5f1cbfae3 100644 --- a/build/docs/ChatFavorite.md +++ b/build/docs/ChatFavorite.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatItem.md b/build/docs/ChatItem.md index f9555e8a3..35d16e195 100644 --- a/build/docs/ChatItem.md +++ b/build/docs/ChatItem.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatItemCursorListing.md b/build/docs/ChatItemCursorListing.md index 7b2279377..8a281b93e 100644 --- a/build/docs/ChatItemCursorListing.md +++ b/build/docs/ChatItemCursorListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatMediaParticipant.md b/build/docs/ChatMediaParticipant.md index 570e04825..96482fa67 100644 --- a/build/docs/ChatMediaParticipant.md +++ b/build/docs/ChatMediaParticipant.md @@ -46,4 +46,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatMediaPolicy.md b/build/docs/ChatMediaPolicy.md index a197569b0..f2608c926 100644 --- a/build/docs/ChatMediaPolicy.md +++ b/build/docs/ChatMediaPolicy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatMediaPolicyConditions.md b/build/docs/ChatMediaPolicyConditions.md index 914758ab8..5857becad 100644 --- a/build/docs/ChatMediaPolicyConditions.md +++ b/build/docs/ChatMediaPolicyConditions.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatMessage.md b/build/docs/ChatMessage.md index a78e02355..9d74c3d6c 100644 --- a/build/docs/ChatMessage.md +++ b/build/docs/ChatMessage.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatMessageEntityListing.md b/build/docs/ChatMessageEntityListing.md index 274e07dd9..7563d5ce9 100644 --- a/build/docs/ChatMessageEntityListing.md +++ b/build/docs/ChatMessageEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatMessageResponse.md b/build/docs/ChatMessageResponse.md index de4fcd15a..7d3fbd13f 100644 --- a/build/docs/ChatMessageResponse.md +++ b/build/docs/ChatMessageResponse.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatMessageUser.md b/build/docs/ChatMessageUser.md index 6fe155ebf..3866a1131 100644 --- a/build/docs/ChatMessageUser.md +++ b/build/docs/ChatMessageUser.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatPresence.md b/build/docs/ChatPresence.md index e228b5e9a..cc754b461 100644 --- a/build/docs/ChatPresence.md +++ b/build/docs/ChatPresence.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatReaction.md b/build/docs/ChatReaction.md index b79f99cc4..90de690c2 100644 --- a/build/docs/ChatReaction.md +++ b/build/docs/ChatReaction.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatReactionUpdate.md b/build/docs/ChatReactionUpdate.md index de686dc8f..27b56ef1d 100644 --- a/build/docs/ChatReactionUpdate.md +++ b/build/docs/ChatReactionUpdate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatSendMessageResponse.md b/build/docs/ChatSendMessageResponse.md index 575960249..75da73312 100644 --- a/build/docs/ChatSendMessageResponse.md +++ b/build/docs/ChatSendMessageResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatSettings.md b/build/docs/ChatSettings.md index c74828f16..1973efa6c 100644 --- a/build/docs/ChatSettings.md +++ b/build/docs/ChatSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ChatUserRef.md b/build/docs/ChatUserRef.md index 308003a0f..4d450e76f 100644 --- a/build/docs/ChatUserRef.md +++ b/build/docs/ChatUserRef.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Check.md b/build/docs/Check.md index 29e45ee24..b17c60742 100644 --- a/build/docs/Check.md +++ b/build/docs/Check.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ClientApp.md b/build/docs/ClientApp.md index bda926cfe..881111a0f 100644 --- a/build/docs/ClientApp.md +++ b/build/docs/ClientApp.md @@ -19,4 +19,4 @@ Details for a ClientApp -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ClientAppConfigurationInfo.md b/build/docs/ClientAppConfigurationInfo.md index 862a8a468..d34167c38 100644 --- a/build/docs/ClientAppConfigurationInfo.md +++ b/build/docs/ClientAppConfigurationInfo.md @@ -12,4 +12,4 @@ Configuration information for the integration -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ClientAppEntityListing.md b/build/docs/ClientAppEntityListing.md index 7df527bfa..1d575a01c 100644 --- a/build/docs/ClientAppEntityListing.md +++ b/build/docs/ClientAppEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ClonedUser.md b/build/docs/ClonedUser.md index 681cbac5a..7d5754894 100644 --- a/build/docs/ClonedUser.md +++ b/build/docs/ClonedUser.md @@ -14,4 +14,4 @@ Represents a cloned user in a trustor organization. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ClonedUserEntityListing.md b/build/docs/ClonedUserEntityListing.md index 5c2adc410..66df058c0 100644 --- a/build/docs/ClonedUserEntityListing.md +++ b/build/docs/ClonedUserEntityListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CloseButtonStyleProperties.md b/build/docs/CloseButtonStyleProperties.md index 0f83a75fc..ef04a3767 100644 --- a/build/docs/CloseButtonStyleProperties.md +++ b/build/docs/CloseButtonStyleProperties.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAPI.md b/build/docs/CoachingAPI.md index bf57535a7..7b2f1815a 100644 --- a/build/docs/CoachingAPI.md +++ b/build/docs/CoachingAPI.md @@ -1074,4 +1074,4 @@ CoachingAPI.postCoachingScheduleslotsQuery(body: body) { (response, error) in [**CoachingSlotsResponse**](CoachingSlotsResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAnnotation.md b/build/docs/CoachingAnnotation.md index bc37e007b..612039fe5 100644 --- a/build/docs/CoachingAnnotation.md +++ b/build/docs/CoachingAnnotation.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAnnotationCreateRequest.md b/build/docs/CoachingAnnotationCreateRequest.md index b4326010a..d26097900 100644 --- a/build/docs/CoachingAnnotationCreateRequest.md +++ b/build/docs/CoachingAnnotationCreateRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAnnotationList.md b/build/docs/CoachingAnnotationList.md index 49223ba8f..7481ae36f 100644 --- a/build/docs/CoachingAnnotationList.md +++ b/build/docs/CoachingAnnotationList.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAppointmentAggregateRequest.md b/build/docs/CoachingAppointmentAggregateRequest.md index 27d455e6a..f1fe3f983 100644 --- a/build/docs/CoachingAppointmentAggregateRequest.md +++ b/build/docs/CoachingAppointmentAggregateRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAppointmentAggregateResponse.md b/build/docs/CoachingAppointmentAggregateResponse.md index 7d129d419..1cb2af26a 100644 --- a/build/docs/CoachingAppointmentAggregateResponse.md +++ b/build/docs/CoachingAppointmentAggregateResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAppointmentReference.md b/build/docs/CoachingAppointmentReference.md index 5db7316fb..278be3580 100644 --- a/build/docs/CoachingAppointmentReference.md +++ b/build/docs/CoachingAppointmentReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAppointmentResponse.md b/build/docs/CoachingAppointmentResponse.md index 633a62b1d..3802a2b3e 100644 --- a/build/docs/CoachingAppointmentResponse.md +++ b/build/docs/CoachingAppointmentResponse.md @@ -29,4 +29,4 @@ Coaching appointment response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAppointmentResponseList.md b/build/docs/CoachingAppointmentResponseList.md index 3271f033e..d9bc199a4 100644 --- a/build/docs/CoachingAppointmentResponseList.md +++ b/build/docs/CoachingAppointmentResponseList.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAppointmentStatusRequest.md b/build/docs/CoachingAppointmentStatusRequest.md index f3338818a..93883070b 100644 --- a/build/docs/CoachingAppointmentStatusRequest.md +++ b/build/docs/CoachingAppointmentStatusRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAppointmentStatusResponse.md b/build/docs/CoachingAppointmentStatusResponse.md index b223af68c..6f6f2b86e 100644 --- a/build/docs/CoachingAppointmentStatusResponse.md +++ b/build/docs/CoachingAppointmentStatusResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingAppointmentStatusResponseList.md b/build/docs/CoachingAppointmentStatusResponseList.md index 613c32c9c..ed4a68f7f 100644 --- a/build/docs/CoachingAppointmentStatusResponseList.md +++ b/build/docs/CoachingAppointmentStatusResponseList.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingNotification.md b/build/docs/CoachingNotification.md index c417b477c..869d02117 100644 --- a/build/docs/CoachingNotification.md +++ b/build/docs/CoachingNotification.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingNotificationList.md b/build/docs/CoachingNotificationList.md index 7a171d044..309d1d20a 100644 --- a/build/docs/CoachingNotificationList.md +++ b/build/docs/CoachingNotificationList.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingSlot.md b/build/docs/CoachingSlot.md index 4500a6cbe..65922ab48 100644 --- a/build/docs/CoachingSlot.md +++ b/build/docs/CoachingSlot.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingSlotsRequest.md b/build/docs/CoachingSlotsRequest.md index 76bd77679..bd369c298 100644 --- a/build/docs/CoachingSlotsRequest.md +++ b/build/docs/CoachingSlotsRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoachingSlotsResponse.md b/build/docs/CoachingSlotsResponse.md index 5dcb1ca53..48bd1f604 100644 --- a/build/docs/CoachingSlotsResponse.md +++ b/build/docs/CoachingSlotsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CobrowseConversation.md b/build/docs/CobrowseConversation.md index a4be97006..238f82c33 100644 --- a/build/docs/CobrowseConversation.md +++ b/build/docs/CobrowseConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CobrowseConversationEntityListing.md b/build/docs/CobrowseConversationEntityListing.md index bfbe0478d..0af765e89 100644 --- a/build/docs/CobrowseConversationEntityListing.md +++ b/build/docs/CobrowseConversationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CobrowseMediaParticipant.md b/build/docs/CobrowseMediaParticipant.md index 83dabbd31..1ce2910ce 100644 --- a/build/docs/CobrowseMediaParticipant.md +++ b/build/docs/CobrowseMediaParticipant.md @@ -49,4 +49,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CobrowseSettings.md b/build/docs/CobrowseSettings.md index add802675..1d0f62fb2 100644 --- a/build/docs/CobrowseSettings.md +++ b/build/docs/CobrowseSettings.md @@ -10,6 +10,7 @@ Settings concerning cobrowse | **enabled** | **Bool** | Whether or not cobrowse is enabled | [optional] | | **allowAgentControl** | **Bool** | Whether the viewer should have option to request control | [optional] | | **allowAgentNavigation** | **Bool** | Whether the viewer should have option to request navigation | [optional] | +| **allowDraw** | **Bool** | Should cobrowse draw be enabled | [optional] | | **maskSelectors** | **[String]** | Mask patterns that will apply to pages being shared | [optional] | | **channels** | **[String]** | Cobrowse channels for web messenger | [optional] | | **readonlySelectors** | **[String]** | Readonly patterns that will apply to pages being shared | [optional] | @@ -17,4 +18,4 @@ Settings concerning cobrowse -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CobrowseWebMessagingSession.md b/build/docs/CobrowseWebMessagingSession.md index 9fd9cef30..bacffa4ef 100644 --- a/build/docs/CobrowseWebMessagingSession.md +++ b/build/docs/CobrowseWebMessagingSession.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Cobrowsesession.md b/build/docs/Cobrowsesession.md index 1b15a54fd..8d028e7cb 100644 --- a/build/docs/Cobrowsesession.md +++ b/build/docs/Cobrowsesession.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CollaborateChatAdhocMessageEventTopicCollaborateChatEntity.md b/build/docs/CollaborateChatAdhocMessageEventTopicCollaborateChatEntity.md index f390532f2..48d9d1f4d 100644 --- a/build/docs/CollaborateChatAdhocMessageEventTopicCollaborateChatEntity.md +++ b/build/docs/CollaborateChatAdhocMessageEventTopicCollaborateChatEntity.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CollaborateChatAdhocMessageEventTopicCollaborateChatMessage.md b/build/docs/CollaborateChatAdhocMessageEventTopicCollaborateChatMessage.md index 956197c69..b8909f2bc 100644 --- a/build/docs/CollaborateChatAdhocMessageEventTopicCollaborateChatMessage.md +++ b/build/docs/CollaborateChatAdhocMessageEventTopicCollaborateChatMessage.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CollaborateChatGroupMessageEventTopicCollaborateChatEntity.md b/build/docs/CollaborateChatGroupMessageEventTopicCollaborateChatEntity.md index 77469bd64..d29f4a068 100644 --- a/build/docs/CollaborateChatGroupMessageEventTopicCollaborateChatEntity.md +++ b/build/docs/CollaborateChatGroupMessageEventTopicCollaborateChatEntity.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CollaborateChatGroupMessageEventTopicCollaborateChatMessage.md b/build/docs/CollaborateChatGroupMessageEventTopicCollaborateChatMessage.md index 918062eb5..af1702356 100644 --- a/build/docs/CollaborateChatGroupMessageEventTopicCollaborateChatMessage.md +++ b/build/docs/CollaborateChatGroupMessageEventTopicCollaborateChatMessage.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Column.md b/build/docs/Column.md index 7b5a4dad8..36439e5b4 100644 --- a/build/docs/Column.md +++ b/build/docs/Column.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ColumnDataTypeSpecification.md b/build/docs/ColumnDataTypeSpecification.md index 4b4854875..9b7e48321 100644 --- a/build/docs/ColumnDataTypeSpecification.md +++ b/build/docs/ColumnDataTypeSpecification.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ColumnStatus.md b/build/docs/ColumnStatus.md index 0f4e7e7eb..65d6b0819 100644 --- a/build/docs/ColumnStatus.md +++ b/build/docs/ColumnStatus.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommandStatus.md b/build/docs/CommandStatus.md index d4ce0e203..e6c00134c 100644 --- a/build/docs/CommandStatus.md +++ b/build/docs/CommandStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommandStatusEntityListing.md b/build/docs/CommandStatusEntityListing.md index 2269a8a8f..76ddec70e 100644 --- a/build/docs/CommandStatusEntityListing.md +++ b/build/docs/CommandStatusEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonAlert.md b/build/docs/CommonAlert.md index 0118e2b05..f0e113d00 100644 --- a/build/docs/CommonAlert.md +++ b/build/docs/CommonAlert.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonAlertBulkUpdateRequest.md b/build/docs/CommonAlertBulkUpdateRequest.md index 780432255..f62859d7f 100644 --- a/build/docs/CommonAlertBulkUpdateRequest.md +++ b/build/docs/CommonAlertBulkUpdateRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonCampaign.md b/build/docs/CommonCampaign.md index 1cbd2e6ee..717729f2a 100644 --- a/build/docs/CommonCampaign.md +++ b/build/docs/CommonCampaign.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonCampaignDivisionView.md b/build/docs/CommonCampaignDivisionView.md index 5a63a64af..7fb9f845f 100644 --- a/build/docs/CommonCampaignDivisionView.md +++ b/build/docs/CommonCampaignDivisionView.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonCampaignDivisionViewEntityListing.md b/build/docs/CommonCampaignDivisionViewEntityListing.md index 1814f06c0..384473d01 100644 --- a/build/docs/CommonCampaignDivisionViewEntityListing.md +++ b/build/docs/CommonCampaignDivisionViewEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonCampaignEntityListing.md b/build/docs/CommonCampaignEntityListing.md index 1f8862fbc..ab1a36ee0 100644 --- a/build/docs/CommonCampaignEntityListing.md +++ b/build/docs/CommonCampaignEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonRule.md b/build/docs/CommonRule.md index 7291e625b..6f341e34a 100644 --- a/build/docs/CommonRule.md +++ b/build/docs/CommonRule.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonRuleBulkDeleteRequest.md b/build/docs/CommonRuleBulkDeleteRequest.md index a1575892c..5b6ba5223 100644 --- a/build/docs/CommonRuleBulkDeleteRequest.md +++ b/build/docs/CommonRuleBulkDeleteRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonRuleBulkUpdateNotificationsRequest.md b/build/docs/CommonRuleBulkUpdateNotificationsRequest.md index 41619547d..770891798 100644 --- a/build/docs/CommonRuleBulkUpdateNotificationsRequest.md +++ b/build/docs/CommonRuleBulkUpdateNotificationsRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonRuleConditions.md b/build/docs/CommonRuleConditions.md index dead9c1fd..52cee98c4 100644 --- a/build/docs/CommonRuleConditions.md +++ b/build/docs/CommonRuleConditions.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonRuleContainer.md b/build/docs/CommonRuleContainer.md index 7b5e610c7..f53591ff5 100644 --- a/build/docs/CommonRuleContainer.md +++ b/build/docs/CommonRuleContainer.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonRulePredicate.md b/build/docs/CommonRulePredicate.md index cfe7977c2..dfc839adf 100644 --- a/build/docs/CommonRulePredicate.md +++ b/build/docs/CommonRulePredicate.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommonRulePredicateEntity.md b/build/docs/CommonRulePredicateEntity.md index c840bd5fc..fe8914103 100644 --- a/build/docs/CommonRulePredicateEntity.md +++ b/build/docs/CommonRulePredicateEntity.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommunicationAnsweredEvent.md b/build/docs/CommunicationAnsweredEvent.md index ef4b7de03..6dcb49776 100644 --- a/build/docs/CommunicationAnsweredEvent.md +++ b/build/docs/CommunicationAnsweredEvent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommunicationDispositionAppliedEvent.md b/build/docs/CommunicationDispositionAppliedEvent.md index bfdffc5a8..efe339199 100644 --- a/build/docs/CommunicationDispositionAppliedEvent.md +++ b/build/docs/CommunicationDispositionAppliedEvent.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CommunicationEndedEvent.md b/build/docs/CommunicationEndedEvent.md index 7c0f19397..d075f4f96 100644 --- a/build/docs/CommunicationEndedEvent.md +++ b/build/docs/CommunicationEndedEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ComparisonPeriod.md b/build/docs/ComparisonPeriod.md index 31e8090a3..45778b5f5 100644 --- a/build/docs/ComparisonPeriod.md +++ b/build/docs/ComparisonPeriod.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ComparisonPeriodListing.md b/build/docs/ComparisonPeriodListing.md index d499f5b19..2fec3bb30 100644 --- a/build/docs/ComparisonPeriodListing.md +++ b/build/docs/ComparisonPeriodListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ComplexVariableInfo.md b/build/docs/ComplexVariableInfo.md index a952b00f8..ec5240ce3 100644 --- a/build/docs/ComplexVariableInfo.md +++ b/build/docs/ComplexVariableInfo.md @@ -12,4 +12,4 @@ Variable type information about a complex type from the bot's definition -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Compliance.md b/build/docs/Compliance.md index 617f6e168..a951c9027 100644 --- a/build/docs/Compliance.md +++ b/build/docs/Compliance.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ComplianceResponse.md b/build/docs/ComplianceResponse.md index caa7c786b..43d362e0f 100644 --- a/build/docs/ComplianceResponse.md +++ b/build/docs/ComplianceResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Condition.md b/build/docs/Condition.md index 2df5c16c3..c3ce02476 100644 --- a/build/docs/Condition.md +++ b/build/docs/Condition.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConditionalGroupRouting.md b/build/docs/ConditionalGroupRouting.md index 123a4c636..702f621f7 100644 --- a/build/docs/ConditionalGroupRouting.md +++ b/build/docs/ConditionalGroupRouting.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConditionalGroupRoutingRule.md b/build/docs/ConditionalGroupRoutingRule.md index 2fe29b896..e417a4d0b 100644 --- a/build/docs/ConditionalGroupRoutingRule.md +++ b/build/docs/ConditionalGroupRoutingRule.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConfigurationOverrides.md b/build/docs/ConfigurationOverrides.md index 0238ad250..0249281b8 100644 --- a/build/docs/ConfigurationOverrides.md +++ b/build/docs/ConfigurationOverrides.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConfusionDetails.md b/build/docs/ConfusionDetails.md index 8fbe9cc19..f59d19e84 100644 --- a/build/docs/ConfusionDetails.md +++ b/build/docs/ConfusionDetails.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConfusionInfo.md b/build/docs/ConfusionInfo.md index a983f812d..232c97bd6 100644 --- a/build/docs/ConfusionInfo.md +++ b/build/docs/ConfusionInfo.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConfusionIntentDetails.md b/build/docs/ConfusionIntentDetails.md index 476d1f724..d0ad6d6a6 100644 --- a/build/docs/ConfusionIntentDetails.md +++ b/build/docs/ConfusionIntentDetails.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConfusionIntentInfo.md b/build/docs/ConfusionIntentInfo.md index 20cef0155..b126eb7d7 100644 --- a/build/docs/ConfusionIntentInfo.md +++ b/build/docs/ConfusionIntentInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConfusionUtterance.md b/build/docs/ConfusionUtterance.md index 4453bf870..f07c97ff7 100644 --- a/build/docs/ConfusionUtterance.md +++ b/build/docs/ConfusionUtterance.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConnectRate.md b/build/docs/ConnectRate.md index 15dd7a0f1..cc5e022ff 100644 --- a/build/docs/ConnectRate.md +++ b/build/docs/ConnectRate.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConnectedEdge.md b/build/docs/ConnectedEdge.md index 2420f8198..f230e1ad3 100644 --- a/build/docs/ConnectedEdge.md +++ b/build/docs/ConnectedEdge.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConnectedQueue.md b/build/docs/ConnectedQueue.md index 6cfaca290..599f8af9d 100644 --- a/build/docs/ConnectedQueue.md +++ b/build/docs/ConnectedQueue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConnectedUser.md b/build/docs/ConnectedUser.md index d99229b53..bf95c684c 100644 --- a/build/docs/ConnectedUser.md +++ b/build/docs/ConnectedUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConstraintConflictMessage.md b/build/docs/ConstraintConflictMessage.md index 4e0fe1728..20a6758f9 100644 --- a/build/docs/ConstraintConflictMessage.md +++ b/build/docs/ConstraintConflictMessage.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsultTransfer.md b/build/docs/ConsultTransfer.md index c86125d27..6c08ae343 100644 --- a/build/docs/ConsultTransfer.md +++ b/build/docs/ConsultTransfer.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsultTransferEvent.md b/build/docs/ConsultTransferEvent.md index b90fdceed..295f3293c 100644 --- a/build/docs/ConsultTransferEvent.md +++ b/build/docs/ConsultTransferEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsultTransferResponse.md b/build/docs/ConsultTransferResponse.md index 7d3721888..718408d46 100644 --- a/build/docs/ConsultTransferResponse.md +++ b/build/docs/ConsultTransferResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsultTransferToAgent.md b/build/docs/ConsultTransferToAgent.md index 7050410d6..9f2fd402f 100644 --- a/build/docs/ConsultTransferToAgent.md +++ b/build/docs/ConsultTransferToAgent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsultTransferToExternal.md b/build/docs/ConsultTransferToExternal.md index c5927b135..ebda36a47 100644 --- a/build/docs/ConsultTransferToExternal.md +++ b/build/docs/ConsultTransferToExternal.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsultTransferToQueue.md b/build/docs/ConsultTransferToQueue.md index 13ba48bdc..fc8b3b7a4 100644 --- a/build/docs/ConsultTransferToQueue.md +++ b/build/docs/ConsultTransferToQueue.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsultTransferUpdate.md b/build/docs/ConsultTransferUpdate.md index 756b3a240..02dba3700 100644 --- a/build/docs/ConsultTransferUpdate.md +++ b/build/docs/ConsultTransferUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsumedResourcesEntityListing.md b/build/docs/ConsumedResourcesEntityListing.md index 53ed5ed41..b5fe43249 100644 --- a/build/docs/ConsumedResourcesEntityListing.md +++ b/build/docs/ConsumedResourcesEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConsumingResourcesEntityListing.md b/build/docs/ConsumingResourcesEntityListing.md index 76ddd8a15..053dcd89d 100644 --- a/build/docs/ConsumingResourcesEntityListing.md +++ b/build/docs/ConsumingResourcesEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Contact.md b/build/docs/Contact.md index af56a740e..19284a369 100644 --- a/build/docs/Contact.md +++ b/build/docs/Contact.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactAddress.md b/build/docs/ContactAddress.md index 68e6be751..3443e4658 100644 --- a/build/docs/ContactAddress.md +++ b/build/docs/ContactAddress.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactAddressConditionSettings.md b/build/docs/ContactAddressConditionSettings.md index fcf25bf3a..cf764c8ea 100644 --- a/build/docs/ContactAddressConditionSettings.md +++ b/build/docs/ContactAddressConditionSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactAddressTypeConditionSettings.md b/build/docs/ContactAddressTypeConditionSettings.md index 51c00b761..b16d7286f 100644 --- a/build/docs/ContactAddressTypeConditionSettings.md +++ b/build/docs/ContactAddressTypeConditionSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactAddressableEntityRef.md b/build/docs/ContactAddressableEntityRef.md index a8a4ad2e4..920a9eea7 100644 --- a/build/docs/ContactAddressableEntityRef.md +++ b/build/docs/ContactAddressableEntityRef.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactBulkEditRequest.md b/build/docs/ContactBulkEditRequest.md index 86da7f44b..299f297ee 100644 --- a/build/docs/ContactBulkEditRequest.md +++ b/build/docs/ContactBulkEditRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactBulkSearchCriteria.md b/build/docs/ContactBulkSearchCriteria.md index 708ba3312..35d20bf47 100644 --- a/build/docs/ContactBulkSearchCriteria.md +++ b/build/docs/ContactBulkSearchCriteria.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactBulkSearchParameters.md b/build/docs/ContactBulkSearchParameters.md index 0026a19cf..1434fe29a 100644 --- a/build/docs/ContactBulkSearchParameters.md +++ b/build/docs/ContactBulkSearchParameters.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactCallbackRequest.md b/build/docs/ContactCallbackRequest.md index cb8acbfb0..8224a2ed2 100644 --- a/build/docs/ContactCallbackRequest.md +++ b/build/docs/ContactCallbackRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactCenterSettings.md b/build/docs/ContactCenterSettings.md index 2e3552918..f2a017557 100644 --- a/build/docs/ContactCenterSettings.md +++ b/build/docs/ContactCenterSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactColumnConditionSettings.md b/build/docs/ContactColumnConditionSettings.md index fd112c384..875f377ed 100644 --- a/build/docs/ContactColumnConditionSettings.md +++ b/build/docs/ContactColumnConditionSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactColumnTimeZone.md b/build/docs/ContactColumnTimeZone.md index 2eee9a61d..3451e70e5 100644 --- a/build/docs/ContactColumnTimeZone.md +++ b/build/docs/ContactColumnTimeZone.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactColumnToDataActionFieldMapping.md b/build/docs/ContactColumnToDataActionFieldMapping.md index 68a4b66b5..64a59aa7c 100644 --- a/build/docs/ContactColumnToDataActionFieldMapping.md +++ b/build/docs/ContactColumnToDataActionFieldMapping.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactDetailEventTopicContactUpdateEvent.md b/build/docs/ContactDetailEventTopicContactUpdateEvent.md index 5f621dd8e..f70ab8707 100644 --- a/build/docs/ContactDetailEventTopicContactUpdateEvent.md +++ b/build/docs/ContactDetailEventTopicContactUpdateEvent.md @@ -30,4 +30,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactIdentifier.md b/build/docs/ContactIdentifier.md index c5cdac4ab..1bb4e7bf4 100644 --- a/build/docs/ContactIdentifier.md +++ b/build/docs/ContactIdentifier.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactIdentifierListing.md b/build/docs/ContactIdentifierListing.md new file mode 100644 index 000000000..15a253501 --- /dev/null +++ b/build/docs/ContactIdentifierListing.md @@ -0,0 +1,13 @@ +# ContactIdentifierListing + +## ContactIdentifierListing + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **entities** | [**[ContactIdentifier]**](ContactIdentifier) | | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportField.md b/build/docs/ContactImportField.md new file mode 100644 index 000000000..b9cb48120 --- /dev/null +++ b/build/docs/ContactImportField.md @@ -0,0 +1,14 @@ +# ContactImportField + +## ContactImportField + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **name** | **String** | Field name | | +| **included** | **Bool** | Should we import this field | | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportJobEntityListing.md b/build/docs/ContactImportJobEntityListing.md new file mode 100644 index 000000000..14b9627bb --- /dev/null +++ b/build/docs/ContactImportJobEntityListing.md @@ -0,0 +1,17 @@ +# ContactImportJobEntityListing + +## ContactImportJobEntityListing + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **entities** | [**[ContactImportJobResponse]**](ContactImportJobResponse) | | [optional] | +| **nextUri** | **String** | | [optional] | +| **selfUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | +| **cursors** | [**Cursors**](Cursors) | The cursor that points to the next set of entities being returned. | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportJobMetadata.md b/build/docs/ContactImportJobMetadata.md new file mode 100644 index 000000000..3521c52d3 --- /dev/null +++ b/build/docs/ContactImportJobMetadata.md @@ -0,0 +1,19 @@ +# ContactImportJobMetadata + +## ContactImportJobMetadata + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **fileName** | **String** | | [optional] | +| **dryRunFailedCount** | **Int** | | [optional] | +| **dryRunSuccessCount** | **Int** | | [optional] | +| **dryRunReportDownloadUrl** | **String** | | [optional] | +| **importFailedCount** | **Int** | | [optional] | +| **importSuccessCount** | **Int** | | [optional] | +| **importReportDownloadUrl** | **String** | | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportJobRequest.md b/build/docs/ContactImportJobRequest.md new file mode 100644 index 000000000..a99e3dfad --- /dev/null +++ b/build/docs/ContactImportJobRequest.md @@ -0,0 +1,13 @@ +# ContactImportJobRequest + +## ContactImportJobRequest + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **settingsId** | **String** | Settings id | | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportJobResponse.md b/build/docs/ContactImportJobResponse.md new file mode 100644 index 000000000..798ac801b --- /dev/null +++ b/build/docs/ContactImportJobResponse.md @@ -0,0 +1,20 @@ +# ContactImportJobResponse + +## ContactImportJobResponse + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **_id** | **String** | The globally unique identifier for the object. | [optional] | +| **status** | **String** | | [optional] | +| **statusDetails** | **String** | Detailed description for JobStatus. | [optional] | +| **executionStep** | **String** | Detailed description for the Job execution state | [optional] | +| **metadata** | [**ContactImportJobMetadata**](ContactImportJobMetadata) | Metadata for the job | [optional] | +| **dateCreated** | [**Date**](Date) | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] | +| **selfUri** | **String** | The URI for this object | [optional] | +| **settings** | [**AddressableEntityRef**](AddressableEntityRef) | Settings | | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportJobStatusUpdateRequest.md b/build/docs/ContactImportJobStatusUpdateRequest.md new file mode 100644 index 000000000..e8e542d00 --- /dev/null +++ b/build/docs/ContactImportJobStatusUpdateRequest.md @@ -0,0 +1,14 @@ +# ContactImportJobStatusUpdateRequest + +## ContactImportJobStatusUpdateRequest + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **jobId** | **String** | Job Id | | +| **status** | **String** | Workflow status | | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportJobStatusUpdateResponse.md b/build/docs/ContactImportJobStatusUpdateResponse.md new file mode 100644 index 000000000..d9ed17cb1 --- /dev/null +++ b/build/docs/ContactImportJobStatusUpdateResponse.md @@ -0,0 +1,14 @@ +# ContactImportJobStatusUpdateResponse + +## ContactImportJobStatusUpdateResponse + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **jobId** | **String** | | [optional] | +| **status** | **String** | | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportSettings.md b/build/docs/ContactImportSettings.md new file mode 100644 index 000000000..1957819ac --- /dev/null +++ b/build/docs/ContactImportSettings.md @@ -0,0 +1,20 @@ +# ContactImportSettings + +## ContactImportSettings + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **_id** | **String** | The globally unique identifier for the object. | [optional] | +| **name** | **String** | Display name for the settings | | +| **matchingCriteria** | **[String]** | Which fields you want to identity resolution based on. (e.g.: Email, Phone). It can be empty, populated only one of them or it can be both for now. The order of the items is important for identity resolution | [optional] | +| **mergeContacts** | **Bool** | Decides what happens when a record already found in the system. Action will be Upsert or Merge | | +| **externalSourceId** | **String** | Define the corresponding source system by the customer, the customer can have different externalId source, they can collect this id from contact service | | +| **importFields** | [**[ContactImportField]**](ContactImportField) | Decides which field we need to send towards contact service | | +| **dateCreated** | [**Date**](Date) | Creation date for the settings. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] | +| **selfUri** | **String** | The URI for this object | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactImportSettingsEntityListing.md b/build/docs/ContactImportSettingsEntityListing.md new file mode 100644 index 000000000..56c458c0b --- /dev/null +++ b/build/docs/ContactImportSettingsEntityListing.md @@ -0,0 +1,17 @@ +# ContactImportSettingsEntityListing + +## ContactImportSettingsEntityListing + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **entities** | [**[ContactImportSettings]**](ContactImportSettings) | | [optional] | +| **nextUri** | **String** | | [optional] | +| **selfUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | +| **cursors** | [**Cursors**](Cursors) | The cursor that points to the next set of entities being returned. | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactList.md b/build/docs/ContactList.md index cce0f5cd8..1aa593fc4 100644 --- a/build/docs/ContactList.md +++ b/build/docs/ContactList.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListDivisionView.md b/build/docs/ContactListDivisionView.md index 918437e4e..82d437dc3 100644 --- a/build/docs/ContactListDivisionView.md +++ b/build/docs/ContactListDivisionView.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListDivisionViewListing.md b/build/docs/ContactListDivisionViewListing.md index df8c4fd99..09a0e2311 100644 --- a/build/docs/ContactListDivisionViewListing.md +++ b/build/docs/ContactListDivisionViewListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListEntityListing.md b/build/docs/ContactListEntityListing.md index 5a22261be..091ea0331 100644 --- a/build/docs/ContactListEntityListing.md +++ b/build/docs/ContactListEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListFilter.md b/build/docs/ContactListFilter.md index 3128e9fd7..156573173 100644 --- a/build/docs/ContactListFilter.md +++ b/build/docs/ContactListFilter.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListFilterBulkRetrieveBody.md b/build/docs/ContactListFilterBulkRetrieveBody.md index f83c69327..7b8f3d571 100644 --- a/build/docs/ContactListFilterBulkRetrieveBody.md +++ b/build/docs/ContactListFilterBulkRetrieveBody.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListFilterClause.md b/build/docs/ContactListFilterClause.md index 10d89e560..e1ed72039 100644 --- a/build/docs/ContactListFilterClause.md +++ b/build/docs/ContactListFilterClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListFilterEntityListing.md b/build/docs/ContactListFilterEntityListing.md index 1ef81deca..0e64138d0 100644 --- a/build/docs/ContactListFilterEntityListing.md +++ b/build/docs/ContactListFilterEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListFilterPredicate.md b/build/docs/ContactListFilterPredicate.md index 8f6ea2998..2bf591ba1 100644 --- a/build/docs/ContactListFilterPredicate.md +++ b/build/docs/ContactListFilterPredicate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListFilterRange.md b/build/docs/ContactListFilterRange.md index 7912e09d4..010a70b9f 100644 --- a/build/docs/ContactListFilterRange.md +++ b/build/docs/ContactListFilterRange.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListTemplate.md b/build/docs/ContactListTemplate.md index d7db4023a..75792b440 100644 --- a/build/docs/ContactListTemplate.md +++ b/build/docs/ContactListTemplate.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListTemplateBulkRetrieveBody.md b/build/docs/ContactListTemplateBulkRetrieveBody.md index bf9f0c9bd..41e6fc2dd 100644 --- a/build/docs/ContactListTemplateBulkRetrieveBody.md +++ b/build/docs/ContactListTemplateBulkRetrieveBody.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListTemplateEntityListing.md b/build/docs/ContactListTemplateEntityListing.md index 363a7f562..fb2d85060 100644 --- a/build/docs/ContactListTemplateEntityListing.md +++ b/build/docs/ContactListTemplateEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListing.md b/build/docs/ContactListing.md index 54b24012a..f877d5069 100644 --- a/build/docs/ContactListing.md +++ b/build/docs/ContactListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **partialResults** | **Bool** | | [optional] | -| **nextUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | | **lastUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListingRequest.md b/build/docs/ContactListingRequest.md index 044d79f81..c9897d3d3 100644 --- a/build/docs/ContactListingRequest.md +++ b/build/docs/ContactListingRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactListingResponse.md b/build/docs/ContactListingResponse.md index 635a3da24..75cbfa012 100644 --- a/build/docs/ContactListingResponse.md +++ b/build/docs/ContactListingResponse.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **contactsCount** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactPhoneNumberColumn.md b/build/docs/ContactPhoneNumberColumn.md index 22487a64f..4a285820d 100644 --- a/build/docs/ContactPhoneNumberColumn.md +++ b/build/docs/ContactPhoneNumberColumn.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactSort.md b/build/docs/ContactSort.md index ecd84f114..93d854b80 100644 --- a/build/docs/ContactSort.md +++ b/build/docs/ContactSort.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactableStatus.md b/build/docs/ContactableStatus.md index e2436c0b7..49cc3b1a4 100644 --- a/build/docs/ContactableStatus.md +++ b/build/docs/ContactableStatus.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactlistDownloadReadyExportUri.md b/build/docs/ContactlistDownloadReadyExportUri.md index d5c9d783d..1e4a35a21 100644 --- a/build/docs/ContactlistDownloadReadyExportUri.md +++ b/build/docs/ContactlistDownloadReadyExportUri.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactlistDownloadReadyObject.md b/build/docs/ContactlistDownloadReadyObject.md index 00071192d..dfec37047 100644 --- a/build/docs/ContactlistDownloadReadyObject.md +++ b/build/docs/ContactlistDownloadReadyObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactlistImportStatusImportStatus.md b/build/docs/ContactlistImportStatusImportStatus.md index b294bcfb4..dbc269573 100644 --- a/build/docs/ContactlistImportStatusImportStatus.md +++ b/build/docs/ContactlistImportStatusImportStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactlistImportStatusObject.md b/build/docs/ContactlistImportStatusObject.md index 23c63fb75..0846cd199 100644 --- a/build/docs/ContactlistImportStatusObject.md +++ b/build/docs/ContactlistImportStatusObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactsBulkOperationJob.md b/build/docs/ContactsBulkOperationJob.md index 2b0256a79..df2b09c7b 100644 --- a/build/docs/ContactsBulkOperationJob.md +++ b/build/docs/ContactsBulkOperationJob.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactsBulkOperationJobListing.md b/build/docs/ContactsBulkOperationJobListing.md index db4a4a0ad..7c55095f2 100644 --- a/build/docs/ContactsBulkOperationJobListing.md +++ b/build/docs/ContactsBulkOperationJobListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContactsExportRequest.md b/build/docs/ContactsExportRequest.md index 2bde3d1f4..95fc0300b 100644 --- a/build/docs/ContactsExportRequest.md +++ b/build/docs/ContactsExportRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentActions.md b/build/docs/ContentActions.md index 8a3576179..7bff9dd7e 100644 --- a/build/docs/ContentActions.md +++ b/build/docs/ContentActions.md @@ -13,4 +13,4 @@ User actions available on the content. All actions are optional and all actions -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentAttachment.md b/build/docs/ContentAttachment.md index 8a1274454..1653fe427 100644 --- a/build/docs/ContentAttachment.md +++ b/build/docs/ContentAttachment.md @@ -18,4 +18,4 @@ Attachment object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentButtonResponse.md b/build/docs/ContentButtonResponse.md index b351b1cb7..254335adf 100644 --- a/build/docs/ContentButtonResponse.md +++ b/build/docs/ContentButtonResponse.md @@ -14,4 +14,4 @@ Button response object representing the click of a structured message button, su -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentCard.md b/build/docs/ContentCard.md index 88f84d349..bd42939d0 100644 --- a/build/docs/ContentCard.md +++ b/build/docs/ContentCard.md @@ -16,4 +16,4 @@ Card content object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentCardAction.md b/build/docs/ContentCardAction.md index cae6d206d..971105b7d 100644 --- a/build/docs/ContentCardAction.md +++ b/build/docs/ContentCardAction.md @@ -14,4 +14,4 @@ A card action that a user can take. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentCarousel.md b/build/docs/ContentCarousel.md index 4845deae0..5568d3fa5 100644 --- a/build/docs/ContentCarousel.md +++ b/build/docs/ContentCarousel.md @@ -11,4 +11,4 @@ Carousel content object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentFileRequest.md b/build/docs/ContentFileRequest.md index 93e2f8a4e..eafd53e33 100644 --- a/build/docs/ContentFileRequest.md +++ b/build/docs/ContentFileRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentFileResponse.md b/build/docs/ContentFileResponse.md index c133868b1..99b56f989 100644 --- a/build/docs/ContentFileResponse.md +++ b/build/docs/ContentFileResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentFilterItem.md b/build/docs/ContentFilterItem.md index 8b0cf7201..5b1975841 100644 --- a/build/docs/ContentFilterItem.md +++ b/build/docs/ContentFilterItem.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentGeneric.md b/build/docs/ContentGeneric.md index 98689a923..0c86d94c2 100644 --- a/build/docs/ContentGeneric.md +++ b/build/docs/ContentGeneric.md @@ -16,4 +16,4 @@ Deprecated, should use Card. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentList.md b/build/docs/ContentList.md index b1c52feda..cd1df438c 100644 --- a/build/docs/ContentList.md +++ b/build/docs/ContentList.md @@ -17,4 +17,4 @@ List content object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentLocation.md b/build/docs/ContentLocation.md index ffc58f30e..9b2989a3e 100644 --- a/build/docs/ContentLocation.md +++ b/build/docs/ContentLocation.md @@ -15,4 +15,4 @@ Location object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementAPI.md b/build/docs/ContentManagementAPI.md index 4ebbe7db0..b0a9fee62 100644 --- a/build/docs/ContentManagementAPI.md +++ b/build/docs/ContentManagementAPI.md @@ -1934,4 +1934,4 @@ ContentManagementAPI.putContentmanagementWorkspaceTagvalue(workspaceId: workspac [**TagValue**](TagValue) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementSingleDocumentTopicDocumentDataV2.md b/build/docs/ContentManagementSingleDocumentTopicDocumentDataV2.md index 4828d2b86..47a673c2e 100644 --- a/build/docs/ContentManagementSingleDocumentTopicDocumentDataV2.md +++ b/build/docs/ContentManagementSingleDocumentTopicDocumentDataV2.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementSingleDocumentTopicLockData.md b/build/docs/ContentManagementSingleDocumentTopicLockData.md index 316537762..1841c581b 100644 --- a/build/docs/ContentManagementSingleDocumentTopicLockData.md +++ b/build/docs/ContentManagementSingleDocumentTopicLockData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementSingleDocumentTopicUserData.md b/build/docs/ContentManagementSingleDocumentTopicUserData.md index 20de77922..4dc2bfbf0 100644 --- a/build/docs/ContentManagementSingleDocumentTopicUserData.md +++ b/build/docs/ContentManagementSingleDocumentTopicUserData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementSingleDocumentTopicWorkspaceData.md b/build/docs/ContentManagementSingleDocumentTopicWorkspaceData.md index 1f0c2483f..75586e45b 100644 --- a/build/docs/ContentManagementSingleDocumentTopicWorkspaceData.md +++ b/build/docs/ContentManagementSingleDocumentTopicWorkspaceData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementWorkspaceDocumentsTopicDocumentDataV2.md b/build/docs/ContentManagementWorkspaceDocumentsTopicDocumentDataV2.md index 2fd44d54e..418b202c5 100644 --- a/build/docs/ContentManagementWorkspaceDocumentsTopicDocumentDataV2.md +++ b/build/docs/ContentManagementWorkspaceDocumentsTopicDocumentDataV2.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementWorkspaceDocumentsTopicLockData.md b/build/docs/ContentManagementWorkspaceDocumentsTopicLockData.md index aca1af929..02bf844e1 100644 --- a/build/docs/ContentManagementWorkspaceDocumentsTopicLockData.md +++ b/build/docs/ContentManagementWorkspaceDocumentsTopicLockData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementWorkspaceDocumentsTopicUserData.md b/build/docs/ContentManagementWorkspaceDocumentsTopicUserData.md index 2a8154568..acbe5d724 100644 --- a/build/docs/ContentManagementWorkspaceDocumentsTopicUserData.md +++ b/build/docs/ContentManagementWorkspaceDocumentsTopicUserData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentManagementWorkspaceDocumentsTopicWorkspaceData.md b/build/docs/ContentManagementWorkspaceDocumentsTopicWorkspaceData.md index 4748093a4..d6909b9fb 100644 --- a/build/docs/ContentManagementWorkspaceDocumentsTopicWorkspaceData.md +++ b/build/docs/ContentManagementWorkspaceDocumentsTopicWorkspaceData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentNotificationTemplate.md b/build/docs/ContentNotificationTemplate.md index 4044f39e6..40ec9a595 100644 --- a/build/docs/ContentNotificationTemplate.md +++ b/build/docs/ContentNotificationTemplate.md @@ -15,4 +15,4 @@ Template notification object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentOffer.md b/build/docs/ContentOffer.md index 021d2b197..e83864488 100644 --- a/build/docs/ContentOffer.md +++ b/build/docs/ContentOffer.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentOfferStyleProperties.md b/build/docs/ContentOfferStyleProperties.md index 1eeb23fe6..a546f4601 100644 --- a/build/docs/ContentOfferStyleProperties.md +++ b/build/docs/ContentOfferStyleProperties.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentOfferStylingConfiguration.md b/build/docs/ContentOfferStylingConfiguration.md index dce550cd5..97c821d61 100644 --- a/build/docs/ContentOfferStylingConfiguration.md +++ b/build/docs/ContentOfferStylingConfiguration.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentPositionProperties.md b/build/docs/ContentPositionProperties.md index 009ccc9b4..d4620870b 100644 --- a/build/docs/ContentPositionProperties.md +++ b/build/docs/ContentPositionProperties.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentPostback.md b/build/docs/ContentPostback.md index e54313463..c61300f11 100644 --- a/build/docs/ContentPostback.md +++ b/build/docs/ContentPostback.md @@ -13,4 +13,4 @@ Postback response object representing the click of a rich media button (Deprecat -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentQuickReply.md b/build/docs/ContentQuickReply.md index ec06dee60..e3e6d8bd7 100644 --- a/build/docs/ContentQuickReply.md +++ b/build/docs/ContentQuickReply.md @@ -15,4 +15,4 @@ Quick reply object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentQuickReplyV2.md b/build/docs/ContentQuickReplyV2.md index 6f5e0a9cc..ba6d0b54c 100644 --- a/build/docs/ContentQuickReplyV2.md +++ b/build/docs/ContentQuickReplyV2.md @@ -12,4 +12,4 @@ Quick reply object V2. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentReaction.md b/build/docs/ContentReaction.md index 01f5de3f9..e97cbb18f 100644 --- a/build/docs/ContentReaction.md +++ b/build/docs/ContentReaction.md @@ -12,4 +12,4 @@ User reaction to public message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentSetting.md b/build/docs/ContentSetting.md index a3afe2f50..d2b9f53d3 100644 --- a/build/docs/ContentSetting.md +++ b/build/docs/ContentSetting.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentStory.md b/build/docs/ContentStory.md index ec9a812c4..0854ec527 100644 --- a/build/docs/ContentStory.md +++ b/build/docs/ContentStory.md @@ -13,4 +13,4 @@ An ephemeral story. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContentText.md b/build/docs/ContentText.md index cd1f55a98..21ec7ba6b 100644 --- a/build/docs/ContentText.md +++ b/build/docs/ContentText.md @@ -12,4 +12,4 @@ Message content element containing text only. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Context.md b/build/docs/Context.md index 832c7bf92..11378f48c 100644 --- a/build/docs/Context.md +++ b/build/docs/Context.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContextEntity.md b/build/docs/ContextEntity.md index e49c828b0..46064317d 100644 --- a/build/docs/ContextEntity.md +++ b/build/docs/ContextEntity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContextIntent.md b/build/docs/ContextIntent.md index ea8ad568a..769d4d9c9 100644 --- a/build/docs/ContextIntent.md +++ b/build/docs/ContextIntent.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ContextPattern.md b/build/docs/ContextPattern.md index 84922e61b..84bce5b8d 100644 --- a/build/docs/ContextPattern.md +++ b/build/docs/ContextPattern.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Conversation.md b/build/docs/Conversation.md index 6b53446b4..786ada752 100644 --- a/build/docs/Conversation.md +++ b/build/docs/Conversation.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityData.md b/build/docs/ConversationActivityData.md index 1293a5426..fcb59f83c 100644 --- a/build/docs/ConversationActivityData.md +++ b/build/docs/ConversationActivityData.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityEntityData.md b/build/docs/ConversationActivityEntityData.md index 290935f33..b85a50595 100644 --- a/build/docs/ConversationActivityEntityData.md +++ b/build/docs/ConversationActivityEntityData.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityMetricValue.md b/build/docs/ConversationActivityMetricValue.md index f9d75c1f4..cc36eaa5d 100644 --- a/build/docs/ConversationActivityMetricValue.md +++ b/build/docs/ConversationActivityMetricValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityQuery.md b/build/docs/ConversationActivityQuery.md index 7b08debaf..b7e2d9b89 100644 --- a/build/docs/ConversationActivityQuery.md +++ b/build/docs/ConversationActivityQuery.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityQueryClause.md b/build/docs/ConversationActivityQueryClause.md index 0e4b32010..242faaf0b 100644 --- a/build/docs/ConversationActivityQueryClause.md +++ b/build/docs/ConversationActivityQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityQueryFilter.md b/build/docs/ConversationActivityQueryFilter.md index 3bdab0796..9c22dfb93 100644 --- a/build/docs/ConversationActivityQueryFilter.md +++ b/build/docs/ConversationActivityQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityQueryMetric.md b/build/docs/ConversationActivityQueryMetric.md index 6eca05de0..76aba64b1 100644 --- a/build/docs/ConversationActivityQueryMetric.md +++ b/build/docs/ConversationActivityQueryMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityQueryPredicate.md b/build/docs/ConversationActivityQueryPredicate.md index 443861d2c..49c58acba 100644 --- a/build/docs/ConversationActivityQueryPredicate.md +++ b/build/docs/ConversationActivityQueryPredicate.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityResponse.md b/build/docs/ConversationActivityResponse.md index 7a03eee4b..4b1c56aa0 100644 --- a/build/docs/ConversationActivityResponse.md +++ b/build/docs/ConversationActivityResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationActivityScoredAgent.md b/build/docs/ConversationActivityScoredAgent.md index 9f4ed9f22..3526ed7d2 100644 --- a/build/docs/ConversationActivityScoredAgent.md +++ b/build/docs/ConversationActivityScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAggregateDataContainer.md b/build/docs/ConversationAggregateDataContainer.md index 1224898a9..3e92b6663 100644 --- a/build/docs/ConversationAggregateDataContainer.md +++ b/build/docs/ConversationAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAggregateQueryClause.md b/build/docs/ConversationAggregateQueryClause.md index c90cdc2ad..c9a766eea 100644 --- a/build/docs/ConversationAggregateQueryClause.md +++ b/build/docs/ConversationAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAggregateQueryFilter.md b/build/docs/ConversationAggregateQueryFilter.md index cae2df4aa..b79ad29b3 100644 --- a/build/docs/ConversationAggregateQueryFilter.md +++ b/build/docs/ConversationAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAggregateQueryPredicate.md b/build/docs/ConversationAggregateQueryPredicate.md index 8904d9f0f..45155a89e 100644 --- a/build/docs/ConversationAggregateQueryPredicate.md +++ b/build/docs/ConversationAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAggregateQueryResponse.md b/build/docs/ConversationAggregateQueryResponse.md index c211970f0..dfad39a40 100644 --- a/build/docs/ConversationAggregateQueryResponse.md +++ b/build/docs/ConversationAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAggregationQuery.md b/build/docs/ConversationAggregationQuery.md index 354b2bbf6..ad797e58d 100644 --- a/build/docs/ConversationAggregationQuery.md +++ b/build/docs/ConversationAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAggregationView.md b/build/docs/ConversationAggregationView.md index 432ecfff1..88c1d9a67 100644 --- a/build/docs/ConversationAggregationView.md +++ b/build/docs/ConversationAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAppSettings.md b/build/docs/ConversationAppSettings.md index 67a4ff087..69d603adf 100644 --- a/build/docs/ConversationAppSettings.md +++ b/build/docs/ConversationAppSettings.md @@ -19,4 +19,4 @@ Conversation settings that handles chats within the messenger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationAssociation.md b/build/docs/ConversationAssociation.md index feede5b38..284f0cdb9 100644 --- a/build/docs/ConversationAssociation.md +++ b/build/docs/ConversationAssociation.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationBasic.md b/build/docs/ConversationBasic.md index 989cc8261..2643e0c46 100644 --- a/build/docs/ConversationBasic.md +++ b/build/docs/ConversationBasic.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicCallConversation.md b/build/docs/ConversationCallEventTopicCallConversation.md index 66062db39..96a3a3072 100644 --- a/build/docs/ConversationCallEventTopicCallConversation.md +++ b/build/docs/ConversationCallEventTopicCallConversation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicCallMediaParticipant.md b/build/docs/ConversationCallEventTopicCallMediaParticipant.md index eef706697..a22392763 100644 --- a/build/docs/ConversationCallEventTopicCallMediaParticipant.md +++ b/build/docs/ConversationCallEventTopicCallMediaParticipant.md @@ -64,4 +64,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicConversationDivisionMembership.md b/build/docs/ConversationCallEventTopicConversationDivisionMembership.md index d243f0314..65312853d 100644 --- a/build/docs/ConversationCallEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationCallEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicConversationRoutingData.md b/build/docs/ConversationCallEventTopicConversationRoutingData.md index 0c6c85908..bcb3a07b5 100644 --- a/build/docs/ConversationCallEventTopicConversationRoutingData.md +++ b/build/docs/ConversationCallEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicDetail.md b/build/docs/ConversationCallEventTopicDetail.md index 456299530..d47e0b9b0 100644 --- a/build/docs/ConversationCallEventTopicDetail.md +++ b/build/docs/ConversationCallEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicDivisionEntityRef.md b/build/docs/ConversationCallEventTopicDivisionEntityRef.md index b6937f550..a01fef994 100644 --- a/build/docs/ConversationCallEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationCallEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicDomainEntityRef.md b/build/docs/ConversationCallEventTopicDomainEntityRef.md index b083fd974..37d4b452e 100644 --- a/build/docs/ConversationCallEventTopicDomainEntityRef.md +++ b/build/docs/ConversationCallEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicErrorBody.md b/build/docs/ConversationCallEventTopicErrorBody.md index c8841a35a..54c7bb79a 100644 --- a/build/docs/ConversationCallEventTopicErrorBody.md +++ b/build/docs/ConversationCallEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicFaxStatus.md b/build/docs/ConversationCallEventTopicFaxStatus.md index c26f9ad6f..072b040df 100644 --- a/build/docs/ConversationCallEventTopicFaxStatus.md +++ b/build/docs/ConversationCallEventTopicFaxStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicJourneyAction.md b/build/docs/ConversationCallEventTopicJourneyAction.md index 46f0b0c4f..b7e8d322e 100644 --- a/build/docs/ConversationCallEventTopicJourneyAction.md +++ b/build/docs/ConversationCallEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicJourneyActionMap.md b/build/docs/ConversationCallEventTopicJourneyActionMap.md index 2f433b048..99f326f68 100644 --- a/build/docs/ConversationCallEventTopicJourneyActionMap.md +++ b/build/docs/ConversationCallEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicJourneyContext.md b/build/docs/ConversationCallEventTopicJourneyContext.md index 852b331d0..8d0e42877 100644 --- a/build/docs/ConversationCallEventTopicJourneyContext.md +++ b/build/docs/ConversationCallEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicJourneyCustomer.md b/build/docs/ConversationCallEventTopicJourneyCustomer.md index 7289b7354..06622daf7 100644 --- a/build/docs/ConversationCallEventTopicJourneyCustomer.md +++ b/build/docs/ConversationCallEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicJourneyCustomerSession.md b/build/docs/ConversationCallEventTopicJourneyCustomerSession.md index 6ed25264d..9fbf995e2 100644 --- a/build/docs/ConversationCallEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationCallEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicLimit.md b/build/docs/ConversationCallEventTopicLimit.md index ee595bb3d..33f63fca9 100644 --- a/build/docs/ConversationCallEventTopicLimit.md +++ b/build/docs/ConversationCallEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicQueueMediaSettings.md b/build/docs/ConversationCallEventTopicQueueMediaSettings.md index e1ae7c8d2..7449c8bd1 100644 --- a/build/docs/ConversationCallEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationCallEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicScoredAgent.md b/build/docs/ConversationCallEventTopicScoredAgent.md index 2b063d2aa..8bcc7e890 100644 --- a/build/docs/ConversationCallEventTopicScoredAgent.md +++ b/build/docs/ConversationCallEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicUriReference.md b/build/docs/ConversationCallEventTopicUriReference.md index 2d08bf15a..39f1bd852 100644 --- a/build/docs/ConversationCallEventTopicUriReference.md +++ b/build/docs/ConversationCallEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallEventTopicWrapup.md b/build/docs/ConversationCallEventTopicWrapup.md index b8da92d39..d826d8639 100644 --- a/build/docs/ConversationCallEventTopicWrapup.md +++ b/build/docs/ConversationCallEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicCallbackConversation.md b/build/docs/ConversationCallbackEventTopicCallbackConversation.md index fb26a357a..ebc460797 100644 --- a/build/docs/ConversationCallbackEventTopicCallbackConversation.md +++ b/build/docs/ConversationCallbackEventTopicCallbackConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md b/build/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md index af38fbcb2..de500321b 100644 --- a/build/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md +++ b/build/docs/ConversationCallbackEventTopicCallbackMediaParticipant.md @@ -58,4 +58,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicConversationDivisionMembership.md b/build/docs/ConversationCallbackEventTopicConversationDivisionMembership.md index 169e55c8e..5c0086d97 100644 --- a/build/docs/ConversationCallbackEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationCallbackEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicConversationRoutingData.md b/build/docs/ConversationCallbackEventTopicConversationRoutingData.md index 5738fb73f..c7c857ba8 100644 --- a/build/docs/ConversationCallbackEventTopicConversationRoutingData.md +++ b/build/docs/ConversationCallbackEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicDetail.md b/build/docs/ConversationCallbackEventTopicDetail.md index 0362ebd6c..77141acd4 100644 --- a/build/docs/ConversationCallbackEventTopicDetail.md +++ b/build/docs/ConversationCallbackEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicDialerPreview.md b/build/docs/ConversationCallbackEventTopicDialerPreview.md index b922b1f32..67afccb1f 100644 --- a/build/docs/ConversationCallbackEventTopicDialerPreview.md +++ b/build/docs/ConversationCallbackEventTopicDialerPreview.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicDivisionEntityRef.md b/build/docs/ConversationCallbackEventTopicDivisionEntityRef.md index 1d0734f55..71e02fae7 100644 --- a/build/docs/ConversationCallbackEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationCallbackEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicDomainEntityRef.md b/build/docs/ConversationCallbackEventTopicDomainEntityRef.md index 2dd02f189..128467452 100644 --- a/build/docs/ConversationCallbackEventTopicDomainEntityRef.md +++ b/build/docs/ConversationCallbackEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicErrorBody.md b/build/docs/ConversationCallbackEventTopicErrorBody.md index c29f3e92b..b44727280 100644 --- a/build/docs/ConversationCallbackEventTopicErrorBody.md +++ b/build/docs/ConversationCallbackEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicJourneyAction.md b/build/docs/ConversationCallbackEventTopicJourneyAction.md index 40e495a79..28bc3a270 100644 --- a/build/docs/ConversationCallbackEventTopicJourneyAction.md +++ b/build/docs/ConversationCallbackEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicJourneyActionMap.md b/build/docs/ConversationCallbackEventTopicJourneyActionMap.md index a1915affb..2a42004d9 100644 --- a/build/docs/ConversationCallbackEventTopicJourneyActionMap.md +++ b/build/docs/ConversationCallbackEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicJourneyContext.md b/build/docs/ConversationCallbackEventTopicJourneyContext.md index a18f759b6..2a91fb962 100644 --- a/build/docs/ConversationCallbackEventTopicJourneyContext.md +++ b/build/docs/ConversationCallbackEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicJourneyCustomer.md b/build/docs/ConversationCallbackEventTopicJourneyCustomer.md index 96a81f729..dcabc6ef9 100644 --- a/build/docs/ConversationCallbackEventTopicJourneyCustomer.md +++ b/build/docs/ConversationCallbackEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicJourneyCustomerSession.md b/build/docs/ConversationCallbackEventTopicJourneyCustomerSession.md index 4d9f98d26..2ad76a7fb 100644 --- a/build/docs/ConversationCallbackEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationCallbackEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicLimit.md b/build/docs/ConversationCallbackEventTopicLimit.md index d6ba35880..1dede1ab9 100644 --- a/build/docs/ConversationCallbackEventTopicLimit.md +++ b/build/docs/ConversationCallbackEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicPhoneNumberColumn.md b/build/docs/ConversationCallbackEventTopicPhoneNumberColumn.md index 50c98cd3d..74118d3e3 100644 --- a/build/docs/ConversationCallbackEventTopicPhoneNumberColumn.md +++ b/build/docs/ConversationCallbackEventTopicPhoneNumberColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicQueueMediaSettings.md b/build/docs/ConversationCallbackEventTopicQueueMediaSettings.md index 05c13ea09..af4ed635b 100644 --- a/build/docs/ConversationCallbackEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationCallbackEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicScoredAgent.md b/build/docs/ConversationCallbackEventTopicScoredAgent.md index 1741aee71..5b44ce821 100644 --- a/build/docs/ConversationCallbackEventTopicScoredAgent.md +++ b/build/docs/ConversationCallbackEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicUriReference.md b/build/docs/ConversationCallbackEventTopicUriReference.md index 76e3ee2c9..b571b2d43 100644 --- a/build/docs/ConversationCallbackEventTopicUriReference.md +++ b/build/docs/ConversationCallbackEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicVoicemail.md b/build/docs/ConversationCallbackEventTopicVoicemail.md index d7c82e515..986e52a86 100644 --- a/build/docs/ConversationCallbackEventTopicVoicemail.md +++ b/build/docs/ConversationCallbackEventTopicVoicemail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCallbackEventTopicWrapup.md b/build/docs/ConversationCallbackEventTopicWrapup.md index f0ddc9fbb..8254a932b 100644 --- a/build/docs/ConversationCallbackEventTopicWrapup.md +++ b/build/docs/ConversationCallbackEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCategoriesEntityListing.md b/build/docs/ConversationCategoriesEntityListing.md index 516817436..4e55fb442 100644 --- a/build/docs/ConversationCategoriesEntityListing.md +++ b/build/docs/ConversationCategoriesEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCategory.md b/build/docs/ConversationCategory.md index 07fd1fe12..87f5a4bbf 100644 --- a/build/docs/ConversationCategory.md +++ b/build/docs/ConversationCategory.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChannel.md b/build/docs/ConversationChannel.md index 51b3df623..65b56bc46 100644 --- a/build/docs/ConversationChannel.md +++ b/build/docs/ConversationChannel.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChannelMetadata.md b/build/docs/ConversationChannelMetadata.md index e486fdd11..c1ea73d05 100644 --- a/build/docs/ConversationChannelMetadata.md +++ b/build/docs/ConversationChannelMetadata.md @@ -10,4 +10,4 @@ Information about the channel. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChat.md b/build/docs/ConversationChat.md index 5b76b685a..b054942a7 100644 --- a/build/docs/ConversationChat.md +++ b/build/docs/ConversationChat.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicChatConversation.md b/build/docs/ConversationChatEventTopicChatConversation.md index edbfacf3a..d7d0e97e0 100644 --- a/build/docs/ConversationChatEventTopicChatConversation.md +++ b/build/docs/ConversationChatEventTopicChatConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicChatMediaParticipant.md b/build/docs/ConversationChatEventTopicChatMediaParticipant.md index 30ef03398..55888fa1b 100644 --- a/build/docs/ConversationChatEventTopicChatMediaParticipant.md +++ b/build/docs/ConversationChatEventTopicChatMediaParticipant.md @@ -51,4 +51,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicConversationDivisionMembership.md b/build/docs/ConversationChatEventTopicConversationDivisionMembership.md index 8856c93c3..c6d8af25b 100644 --- a/build/docs/ConversationChatEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationChatEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicConversationRoutingData.md b/build/docs/ConversationChatEventTopicConversationRoutingData.md index e97e38a63..fc857ccb4 100644 --- a/build/docs/ConversationChatEventTopicConversationRoutingData.md +++ b/build/docs/ConversationChatEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicDetail.md b/build/docs/ConversationChatEventTopicDetail.md index 473838469..aec4afa6b 100644 --- a/build/docs/ConversationChatEventTopicDetail.md +++ b/build/docs/ConversationChatEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicDivisionEntityRef.md b/build/docs/ConversationChatEventTopicDivisionEntityRef.md index cea671d24..26ebc5e46 100644 --- a/build/docs/ConversationChatEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationChatEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicDomainEntityRef.md b/build/docs/ConversationChatEventTopicDomainEntityRef.md index b99d40b06..4a9ea8f5d 100644 --- a/build/docs/ConversationChatEventTopicDomainEntityRef.md +++ b/build/docs/ConversationChatEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicErrorBody.md b/build/docs/ConversationChatEventTopicErrorBody.md index 825593ee2..635946b1a 100644 --- a/build/docs/ConversationChatEventTopicErrorBody.md +++ b/build/docs/ConversationChatEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicJourneyAction.md b/build/docs/ConversationChatEventTopicJourneyAction.md index 80ce871e0..5c4ff7b29 100644 --- a/build/docs/ConversationChatEventTopicJourneyAction.md +++ b/build/docs/ConversationChatEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicJourneyActionMap.md b/build/docs/ConversationChatEventTopicJourneyActionMap.md index 0e8cc04cc..1c5e6a454 100644 --- a/build/docs/ConversationChatEventTopicJourneyActionMap.md +++ b/build/docs/ConversationChatEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicJourneyContext.md b/build/docs/ConversationChatEventTopicJourneyContext.md index 0d621324e..9fc14f6ce 100644 --- a/build/docs/ConversationChatEventTopicJourneyContext.md +++ b/build/docs/ConversationChatEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicJourneyCustomer.md b/build/docs/ConversationChatEventTopicJourneyCustomer.md index fd25ae7e2..430b2b682 100644 --- a/build/docs/ConversationChatEventTopicJourneyCustomer.md +++ b/build/docs/ConversationChatEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicJourneyCustomerSession.md b/build/docs/ConversationChatEventTopicJourneyCustomerSession.md index 74b4221bd..7c2d257c2 100644 --- a/build/docs/ConversationChatEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationChatEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicLimit.md b/build/docs/ConversationChatEventTopicLimit.md index 3d515061c..5cb5eedea 100644 --- a/build/docs/ConversationChatEventTopicLimit.md +++ b/build/docs/ConversationChatEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicQueueMediaSettings.md b/build/docs/ConversationChatEventTopicQueueMediaSettings.md index ebb3f5014..b78981149 100644 --- a/build/docs/ConversationChatEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationChatEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicScoredAgent.md b/build/docs/ConversationChatEventTopicScoredAgent.md index f09b98e0b..5a8fe6a77 100644 --- a/build/docs/ConversationChatEventTopicScoredAgent.md +++ b/build/docs/ConversationChatEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicUriReference.md b/build/docs/ConversationChatEventTopicUriReference.md index 9dead3bb9..a4f32e16b 100644 --- a/build/docs/ConversationChatEventTopicUriReference.md +++ b/build/docs/ConversationChatEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationChatEventTopicWrapup.md b/build/docs/ConversationChatEventTopicWrapup.md index 862c28ca5..50cc91798 100644 --- a/build/docs/ConversationChatEventTopicWrapup.md +++ b/build/docs/ConversationChatEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationClearSettings.md b/build/docs/ConversationClearSettings.md index cdb14aeff..fbc64e201 100644 --- a/build/docs/ConversationClearSettings.md +++ b/build/docs/ConversationClearSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicCobrowseConversation.md b/build/docs/ConversationCobrowseEventTopicCobrowseConversation.md index 89d009989..8c361d9e8 100644 --- a/build/docs/ConversationCobrowseEventTopicCobrowseConversation.md +++ b/build/docs/ConversationCobrowseEventTopicCobrowseConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md b/build/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md index e3610267f..a114d7d76 100644 --- a/build/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md +++ b/build/docs/ConversationCobrowseEventTopicCobrowseMediaParticipant.md @@ -54,4 +54,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicConversationDivisionMembership.md b/build/docs/ConversationCobrowseEventTopicConversationDivisionMembership.md index d996ea928..ae663202c 100644 --- a/build/docs/ConversationCobrowseEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationCobrowseEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicConversationRoutingData.md b/build/docs/ConversationCobrowseEventTopicConversationRoutingData.md index efad7dfff..7bbc4c108 100644 --- a/build/docs/ConversationCobrowseEventTopicConversationRoutingData.md +++ b/build/docs/ConversationCobrowseEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicDetail.md b/build/docs/ConversationCobrowseEventTopicDetail.md index 1c25086e6..8813679c0 100644 --- a/build/docs/ConversationCobrowseEventTopicDetail.md +++ b/build/docs/ConversationCobrowseEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicDivisionEntityRef.md b/build/docs/ConversationCobrowseEventTopicDivisionEntityRef.md index 2d597297c..52bc151e1 100644 --- a/build/docs/ConversationCobrowseEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationCobrowseEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicDomainEntityRef.md b/build/docs/ConversationCobrowseEventTopicDomainEntityRef.md index bade4cbb0..e9631b468 100644 --- a/build/docs/ConversationCobrowseEventTopicDomainEntityRef.md +++ b/build/docs/ConversationCobrowseEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicErrorBody.md b/build/docs/ConversationCobrowseEventTopicErrorBody.md index f5a7bcd3c..4119c42be 100644 --- a/build/docs/ConversationCobrowseEventTopicErrorBody.md +++ b/build/docs/ConversationCobrowseEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicJourneyAction.md b/build/docs/ConversationCobrowseEventTopicJourneyAction.md index 3b2d10a3e..83c265295 100644 --- a/build/docs/ConversationCobrowseEventTopicJourneyAction.md +++ b/build/docs/ConversationCobrowseEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicJourneyActionMap.md b/build/docs/ConversationCobrowseEventTopicJourneyActionMap.md index 46a103510..1b93b6cbe 100644 --- a/build/docs/ConversationCobrowseEventTopicJourneyActionMap.md +++ b/build/docs/ConversationCobrowseEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicJourneyContext.md b/build/docs/ConversationCobrowseEventTopicJourneyContext.md index bf416ccda..b04d6f944 100644 --- a/build/docs/ConversationCobrowseEventTopicJourneyContext.md +++ b/build/docs/ConversationCobrowseEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicJourneyCustomer.md b/build/docs/ConversationCobrowseEventTopicJourneyCustomer.md index 0dddc00d3..ad46bc5f5 100644 --- a/build/docs/ConversationCobrowseEventTopicJourneyCustomer.md +++ b/build/docs/ConversationCobrowseEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicJourneyCustomerSession.md b/build/docs/ConversationCobrowseEventTopicJourneyCustomerSession.md index 7661ac0a5..003912a40 100644 --- a/build/docs/ConversationCobrowseEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationCobrowseEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicLimit.md b/build/docs/ConversationCobrowseEventTopicLimit.md index 21dac18ae..d7114a90b 100644 --- a/build/docs/ConversationCobrowseEventTopicLimit.md +++ b/build/docs/ConversationCobrowseEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicQueueMediaSettings.md b/build/docs/ConversationCobrowseEventTopicQueueMediaSettings.md index 3c42f162e..a19437f6b 100644 --- a/build/docs/ConversationCobrowseEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationCobrowseEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicScoredAgent.md b/build/docs/ConversationCobrowseEventTopicScoredAgent.md index 18a21b45f..a52c64023 100644 --- a/build/docs/ConversationCobrowseEventTopicScoredAgent.md +++ b/build/docs/ConversationCobrowseEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicUriReference.md b/build/docs/ConversationCobrowseEventTopicUriReference.md index 873f0e5a5..9a4b7a9a6 100644 --- a/build/docs/ConversationCobrowseEventTopicUriReference.md +++ b/build/docs/ConversationCobrowseEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationCobrowseEventTopicWrapup.md b/build/docs/ConversationCobrowseEventTopicWrapup.md index 3ede8e976..3b0f6a970 100644 --- a/build/docs/ConversationCobrowseEventTopicWrapup.md +++ b/build/docs/ConversationCobrowseEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentAttachment.md b/build/docs/ConversationContentAttachment.md index 7b3f7be09..13da2a09a 100644 --- a/build/docs/ConversationContentAttachment.md +++ b/build/docs/ConversationContentAttachment.md @@ -18,4 +18,4 @@ Attachment object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentButtonResponse.md b/build/docs/ConversationContentButtonResponse.md index bbc5d6742..ec8d7b306 100644 --- a/build/docs/ConversationContentButtonResponse.md +++ b/build/docs/ConversationContentButtonResponse.md @@ -13,4 +13,4 @@ Button response object representing the click of a structured message button, su -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentCard.md b/build/docs/ConversationContentCard.md index d6cd0fc8f..533381f75 100644 --- a/build/docs/ConversationContentCard.md +++ b/build/docs/ConversationContentCard.md @@ -16,4 +16,4 @@ Card content object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentCardAction.md b/build/docs/ConversationContentCardAction.md index b9b2ef17a..09cd31d9e 100644 --- a/build/docs/ConversationContentCardAction.md +++ b/build/docs/ConversationContentCardAction.md @@ -14,4 +14,4 @@ A card action that a user can take. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentCarousel.md b/build/docs/ConversationContentCarousel.md index 7b05c3362..8ef549086 100644 --- a/build/docs/ConversationContentCarousel.md +++ b/build/docs/ConversationContentCarousel.md @@ -11,4 +11,4 @@ Carousel content object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentDatePicker.md b/build/docs/ConversationContentDatePicker.md new file mode 100644 index 000000000..a14c81c1c --- /dev/null +++ b/build/docs/ConversationContentDatePicker.md @@ -0,0 +1,19 @@ +# ConversationContentDatePicker + +## ConversationContentDatePicker +DateTimePicker content object. + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **title** | **String** | Text to show in the title. | [optional] | +| **subtitle** | **String** | Text to show in the description. | [optional] | +| **imageUrl** | **String** | URL of an image | [optional] | +| **dateMinimum** | [**Date**](Date) | The minimum Date Enabled in the datepicker calendar, format: ISO 8601. | [optional] | +| **dateMaximum** | [**Date**](Date) | The maximum Date Enabled in the datepicker calendar, format: ISO 8601. | [optional] | +| **availableTimes** | [**[ConversationContentDatePickerAvailableTime]**](ConversationContentDatePickerAvailableTime) | An array of available times objects. | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentDatePickerAvailableTime.md b/build/docs/ConversationContentDatePickerAvailableTime.md new file mode 100644 index 000000000..6bd77deaf --- /dev/null +++ b/build/docs/ConversationContentDatePickerAvailableTime.md @@ -0,0 +1,15 @@ +# ConversationContentDatePickerAvailableTime + +## ConversationContentDatePickerAvailableTime +A datetimepicker available time that a user can take. + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **duration** | **Int64** | The duration of the scheduling event in seconds. | [optional] | +| **dateTime** | [**Date**](Date) | The date and time of the event being scheduled. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentLocation.md b/build/docs/ConversationContentLocation.md index c9dc850af..f3ceff227 100644 --- a/build/docs/ConversationContentLocation.md +++ b/build/docs/ConversationContentLocation.md @@ -15,4 +15,4 @@ Location object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentNotificationTemplate.md b/build/docs/ConversationContentNotificationTemplate.md index ae22c2dba..83f948e77 100644 --- a/build/docs/ConversationContentNotificationTemplate.md +++ b/build/docs/ConversationContentNotificationTemplate.md @@ -15,4 +15,4 @@ Template notification object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentQuickReply.md b/build/docs/ConversationContentQuickReply.md index 08fe9c17b..a9cafbe03 100644 --- a/build/docs/ConversationContentQuickReply.md +++ b/build/docs/ConversationContentQuickReply.md @@ -14,4 +14,4 @@ Quick reply object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentQuickReplyV2.md b/build/docs/ConversationContentQuickReplyV2.md index 057251a83..35bd68acf 100644 --- a/build/docs/ConversationContentQuickReplyV2.md +++ b/build/docs/ConversationContentQuickReplyV2.md @@ -12,4 +12,4 @@ Quick reply object V2. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentReaction.md b/build/docs/ConversationContentReaction.md index f9759f1fd..f58f93afe 100644 --- a/build/docs/ConversationContentReaction.md +++ b/build/docs/ConversationContentReaction.md @@ -12,4 +12,4 @@ User reaction to public message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentStory.md b/build/docs/ConversationContentStory.md index 95b51bdf3..f670bb863 100644 --- a/build/docs/ConversationContentStory.md +++ b/build/docs/ConversationContentStory.md @@ -13,4 +13,4 @@ An ephemeral story. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationContentText.md b/build/docs/ConversationContentText.md index 72c6c38fc..a17e75291 100644 --- a/build/docs/ConversationContentText.md +++ b/build/docs/ConversationContentText.md @@ -12,4 +12,4 @@ Message content element containing text only. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationDeletionProtectionQuery.md b/build/docs/ConversationDeletionProtectionQuery.md index f55eddab0..be3782ef7 100644 --- a/build/docs/ConversationDeletionProtectionQuery.md +++ b/build/docs/ConversationDeletionProtectionQuery.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationDetailQueryClause.md b/build/docs/ConversationDetailQueryClause.md index 126bee268..27c533f28 100644 --- a/build/docs/ConversationDetailQueryClause.md +++ b/build/docs/ConversationDetailQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationDetailQueryFilter.md b/build/docs/ConversationDetailQueryFilter.md index 355415d22..b5780ee52 100644 --- a/build/docs/ConversationDetailQueryFilter.md +++ b/build/docs/ConversationDetailQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationDetailQueryPredicate.md b/build/docs/ConversationDetailQueryPredicate.md index 109b170d3..c2d53053e 100644 --- a/build/docs/ConversationDetailQueryPredicate.md +++ b/build/docs/ConversationDetailQueryPredicate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification.md b/build/docs/ConversationDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification.md index 2e8c05908..88a3cd80f 100644 --- a/build/docs/ConversationDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification.md +++ b/build/docs/ConversationDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationDisconnectSettings.md b/build/docs/ConversationDisconnectSettings.md index ab0c8d27b..1d4da47a4 100644 --- a/build/docs/ConversationDisconnectSettings.md +++ b/build/docs/ConversationDisconnectSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationDivisionMembership.md b/build/docs/ConversationDivisionMembership.md index f99d4d441..101a59567 100644 --- a/build/docs/ConversationDivisionMembership.md +++ b/build/docs/ConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEditedSummary.md b/build/docs/ConversationEditedSummary.md index 68bb8f2f5..9dc9d02b6 100644 --- a/build/docs/ConversationEditedSummary.md +++ b/build/docs/ConversationEditedSummary.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicAttachment.md b/build/docs/ConversationEmailEventTopicAttachment.md index 20238c7e8..d81aa08cf 100644 --- a/build/docs/ConversationEmailEventTopicAttachment.md +++ b/build/docs/ConversationEmailEventTopicAttachment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicConversationDivisionMembership.md b/build/docs/ConversationEmailEventTopicConversationDivisionMembership.md index 53ba2cfc7..b5924946c 100644 --- a/build/docs/ConversationEmailEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationEmailEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicConversationRoutingData.md b/build/docs/ConversationEmailEventTopicConversationRoutingData.md index 80ea03837..acfb19be9 100644 --- a/build/docs/ConversationEmailEventTopicConversationRoutingData.md +++ b/build/docs/ConversationEmailEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicDetail.md b/build/docs/ConversationEmailEventTopicDetail.md index ad229c622..7a563d53d 100644 --- a/build/docs/ConversationEmailEventTopicDetail.md +++ b/build/docs/ConversationEmailEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicDivisionEntityRef.md b/build/docs/ConversationEmailEventTopicDivisionEntityRef.md index ff5cd8f24..5525fcd59 100644 --- a/build/docs/ConversationEmailEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationEmailEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicDomainEntityRef.md b/build/docs/ConversationEmailEventTopicDomainEntityRef.md index 778a8e474..921aec8b3 100644 --- a/build/docs/ConversationEmailEventTopicDomainEntityRef.md +++ b/build/docs/ConversationEmailEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicEmailConversation.md b/build/docs/ConversationEmailEventTopicEmailConversation.md index 5eb373958..c2b975bc3 100644 --- a/build/docs/ConversationEmailEventTopicEmailConversation.md +++ b/build/docs/ConversationEmailEventTopicEmailConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicEmailMediaParticipant.md b/build/docs/ConversationEmailEventTopicEmailMediaParticipant.md index 06e667d1d..3bf60ad2f 100644 --- a/build/docs/ConversationEmailEventTopicEmailMediaParticipant.md +++ b/build/docs/ConversationEmailEventTopicEmailMediaParticipant.md @@ -55,4 +55,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicErrorBody.md b/build/docs/ConversationEmailEventTopicErrorBody.md index c040885ed..1b65af1ac 100644 --- a/build/docs/ConversationEmailEventTopicErrorBody.md +++ b/build/docs/ConversationEmailEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicJourneyAction.md b/build/docs/ConversationEmailEventTopicJourneyAction.md index 934e19c0e..c605221ae 100644 --- a/build/docs/ConversationEmailEventTopicJourneyAction.md +++ b/build/docs/ConversationEmailEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicJourneyActionMap.md b/build/docs/ConversationEmailEventTopicJourneyActionMap.md index d8d1cfdb9..d3ece75b9 100644 --- a/build/docs/ConversationEmailEventTopicJourneyActionMap.md +++ b/build/docs/ConversationEmailEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicJourneyContext.md b/build/docs/ConversationEmailEventTopicJourneyContext.md index b8f24eed5..51374aa70 100644 --- a/build/docs/ConversationEmailEventTopicJourneyContext.md +++ b/build/docs/ConversationEmailEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicJourneyCustomer.md b/build/docs/ConversationEmailEventTopicJourneyCustomer.md index 75b65c947..2a078bb6c 100644 --- a/build/docs/ConversationEmailEventTopicJourneyCustomer.md +++ b/build/docs/ConversationEmailEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicJourneyCustomerSession.md b/build/docs/ConversationEmailEventTopicJourneyCustomerSession.md index a5486613c..e2aa5f3d2 100644 --- a/build/docs/ConversationEmailEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationEmailEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicLimit.md b/build/docs/ConversationEmailEventTopicLimit.md index cc37dd3c5..ed16e2a05 100644 --- a/build/docs/ConversationEmailEventTopicLimit.md +++ b/build/docs/ConversationEmailEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicQueueMediaSettings.md b/build/docs/ConversationEmailEventTopicQueueMediaSettings.md index 816e2f18d..61795084b 100644 --- a/build/docs/ConversationEmailEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationEmailEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicScoredAgent.md b/build/docs/ConversationEmailEventTopicScoredAgent.md index ae393d611..a909600d0 100644 --- a/build/docs/ConversationEmailEventTopicScoredAgent.md +++ b/build/docs/ConversationEmailEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicUriReference.md b/build/docs/ConversationEmailEventTopicUriReference.md index 32bc39f7e..2eba7aa8d 100644 --- a/build/docs/ConversationEmailEventTopicUriReference.md +++ b/build/docs/ConversationEmailEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEmailEventTopicWrapup.md b/build/docs/ConversationEmailEventTopicWrapup.md index af246e7c2..32fc28bc0 100644 --- a/build/docs/ConversationEmailEventTopicWrapup.md +++ b/build/docs/ConversationEmailEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEncryptionConfiguration.md b/build/docs/ConversationEncryptionConfiguration.md index e9a517f04..a76eb8f1d 100644 --- a/build/docs/ConversationEncryptionConfiguration.md +++ b/build/docs/ConversationEncryptionConfiguration.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEncryptionConfigurationListing.md b/build/docs/ConversationEncryptionConfigurationListing.md index 290a019a0..1cd3c58ea 100644 --- a/build/docs/ConversationEncryptionConfigurationListing.md +++ b/build/docs/ConversationEncryptionConfigurationListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEnrichment.md b/build/docs/ConversationEnrichment.md index c89411b41..553961dea 100644 --- a/build/docs/ConversationEnrichment.md +++ b/build/docs/ConversationEnrichment.md @@ -12,4 +12,4 @@ Metadata enrichments provided by the platform. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEnrichmentLanguage.md b/build/docs/ConversationEnrichmentLanguage.md index 1cb4180f1..5b95d7d7d 100644 --- a/build/docs/ConversationEnrichmentLanguage.md +++ b/build/docs/ConversationEnrichmentLanguage.md @@ -11,4 +11,4 @@ Detected language of this message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEnrichmentSentimentV2.md b/build/docs/ConversationEnrichmentSentimentV2.md index e31b2ed32..dcafa05e2 100644 --- a/build/docs/ConversationEnrichmentSentimentV2.md +++ b/build/docs/ConversationEnrichmentSentimentV2.md @@ -11,4 +11,4 @@ Sentiment analysis of this message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEntityListing.md b/build/docs/ConversationEntityListing.md index 813e60c77..337d7c109 100644 --- a/build/docs/ConversationEntityListing.md +++ b/build/docs/ConversationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventCoBrowse.md b/build/docs/ConversationEventCoBrowse.md index 6de432623..bee0b5722 100644 --- a/build/docs/ConversationEventCoBrowse.md +++ b/build/docs/ConversationEventCoBrowse.md @@ -13,4 +13,4 @@ A CoBrowse event. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventPresence.md b/build/docs/ConversationEventPresence.md index afac2a2eb..3f4c4b3f3 100644 --- a/build/docs/ConversationEventPresence.md +++ b/build/docs/ConversationEventPresence.md @@ -11,4 +11,4 @@ A Presence event. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicAddress.md b/build/docs/ConversationEventTopicAddress.md index 1b791f7ff..ffe9e5860 100644 --- a/build/docs/ConversationEventTopicAddress.md +++ b/build/docs/ConversationEventTopicAddress.md @@ -15,4 +15,4 @@ Address and name data for a call endpoint. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicAfterCallWork.md b/build/docs/ConversationEventTopicAfterCallWork.md index f73933d5a..6cfad282f 100644 --- a/build/docs/ConversationEventTopicAfterCallWork.md +++ b/build/docs/ConversationEventTopicAfterCallWork.md @@ -13,4 +13,4 @@ A communication's after-call work data. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicAttachment.md b/build/docs/ConversationEventTopicAttachment.md index 8d099f96c..d12d02e13 100644 --- a/build/docs/ConversationEventTopicAttachment.md +++ b/build/docs/ConversationEventTopicAttachment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicCall.md b/build/docs/ConversationEventTopicCall.md index 8e90490f9..c32896c68 100644 --- a/build/docs/ConversationEventTopicCall.md +++ b/build/docs/ConversationEventTopicCall.md @@ -39,4 +39,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicCallback.md b/build/docs/ConversationEventTopicCallback.md index ee4fb23b7..17157c914 100644 --- a/build/docs/ConversationEventTopicCallback.md +++ b/build/docs/ConversationEventTopicCallback.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicChat.md b/build/docs/ConversationEventTopicChat.md index 9297634da..b7302a249 100644 --- a/build/docs/ConversationEventTopicChat.md +++ b/build/docs/ConversationEventTopicChat.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicCobrowse.md b/build/docs/ConversationEventTopicCobrowse.md index 8631bc109..2139677e7 100644 --- a/build/docs/ConversationEventTopicCobrowse.md +++ b/build/docs/ConversationEventTopicCobrowse.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicConversation.md b/build/docs/ConversationEventTopicConversation.md index 4e4f9cca5..bd69b50a8 100644 --- a/build/docs/ConversationEventTopicConversation.md +++ b/build/docs/ConversationEventTopicConversation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicConversationDivisionMembership.md b/build/docs/ConversationEventTopicConversationDivisionMembership.md index 6b554c030..8e37647ff 100644 --- a/build/docs/ConversationEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicConversationRoutingData.md b/build/docs/ConversationEventTopicConversationRoutingData.md index bb3faaadf..ca3aaa461 100644 --- a/build/docs/ConversationEventTopicConversationRoutingData.md +++ b/build/docs/ConversationEventTopicConversationRoutingData.md @@ -15,4 +15,4 @@ Information on how a communication should be routed to an agent. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicDialerPreview.md b/build/docs/ConversationEventTopicDialerPreview.md index f584ac932..e1776c463 100644 --- a/build/docs/ConversationEventTopicDialerPreview.md +++ b/build/docs/ConversationEventTopicDialerPreview.md @@ -15,4 +15,4 @@ The preview data to be used when this callback is a Preview. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicDisconnectReason.md b/build/docs/ConversationEventTopicDisconnectReason.md index d3a397c79..2b156cada 100644 --- a/build/docs/ConversationEventTopicDisconnectReason.md +++ b/build/docs/ConversationEventTopicDisconnectReason.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicDivisionEntityRef.md b/build/docs/ConversationEventTopicDivisionEntityRef.md index 0fb5c1120..ffbcfbd80 100644 --- a/build/docs/ConversationEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicDomainEntityRef.md b/build/docs/ConversationEventTopicDomainEntityRef.md index 061f26281..1386ea8fd 100644 --- a/build/docs/ConversationEventTopicDomainEntityRef.md +++ b/build/docs/ConversationEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicEmail.md b/build/docs/ConversationEventTopicEmail.md index 23e382bf2..a3f2bdc52 100644 --- a/build/docs/ConversationEventTopicEmail.md +++ b/build/docs/ConversationEventTopicEmail.md @@ -34,4 +34,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicErrorDetails.md b/build/docs/ConversationEventTopicErrorDetails.md index 75868b1fb..14f500cf5 100644 --- a/build/docs/ConversationEventTopicErrorDetails.md +++ b/build/docs/ConversationEventTopicErrorDetails.md @@ -17,4 +17,4 @@ Detailed information about an error response. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicFaxStatus.md b/build/docs/ConversationEventTopicFaxStatus.md index 0788e3c53..4bee23ff4 100644 --- a/build/docs/ConversationEventTopicFaxStatus.md +++ b/build/docs/ConversationEventTopicFaxStatus.md @@ -18,4 +18,4 @@ Extra information on fax transmission. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicInternalMessage.md b/build/docs/ConversationEventTopicInternalMessage.md index 61a433df6..3e04855d8 100644 --- a/build/docs/ConversationEventTopicInternalMessage.md +++ b/build/docs/ConversationEventTopicInternalMessage.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicInternalMessageDetails.md b/build/docs/ConversationEventTopicInternalMessageDetails.md index b519fd418..875101c0b 100644 --- a/build/docs/ConversationEventTopicInternalMessageDetails.md +++ b/build/docs/ConversationEventTopicInternalMessageDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicJourneyAction.md b/build/docs/ConversationEventTopicJourneyAction.md index 174d2fcad..11ed7a155 100644 --- a/build/docs/ConversationEventTopicJourneyAction.md +++ b/build/docs/ConversationEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicJourneyActionMap.md b/build/docs/ConversationEventTopicJourneyActionMap.md index 57c6aa6e2..112e2da00 100644 --- a/build/docs/ConversationEventTopicJourneyActionMap.md +++ b/build/docs/ConversationEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicJourneyContext.md b/build/docs/ConversationEventTopicJourneyContext.md index e5458e502..a2a4861a7 100644 --- a/build/docs/ConversationEventTopicJourneyContext.md +++ b/build/docs/ConversationEventTopicJourneyContext.md @@ -13,4 +13,4 @@ A subset of the Journey System's data relevant to a part of a conversation ( -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicJourneyCustomer.md b/build/docs/ConversationEventTopicJourneyCustomer.md index 6831c2102..9bf2846c0 100644 --- a/build/docs/ConversationEventTopicJourneyCustomer.md +++ b/build/docs/ConversationEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicJourneyCustomerSession.md b/build/docs/ConversationEventTopicJourneyCustomerSession.md index faa93eb70..6444bd40d 100644 --- a/build/docs/ConversationEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicMessage.md b/build/docs/ConversationEventTopicMessage.md index 65cca4bc6..ca1c72e48 100644 --- a/build/docs/ConversationEventTopicMessage.md +++ b/build/docs/ConversationEventTopicMessage.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicMessageDetails.md b/build/docs/ConversationEventTopicMessageDetails.md index 985c7f0b3..80371542d 100644 --- a/build/docs/ConversationEventTopicMessageDetails.md +++ b/build/docs/ConversationEventTopicMessageDetails.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicMessageMedia.md b/build/docs/ConversationEventTopicMessageMedia.md index 12f5a3f4e..8eaf41542 100644 --- a/build/docs/ConversationEventTopicMessageMedia.md +++ b/build/docs/ConversationEventTopicMessageMedia.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicMessageMetadata.md b/build/docs/ConversationEventTopicMessageMetadata.md index e83e022a1..9824e0c74 100644 --- a/build/docs/ConversationEventTopicMessageMetadata.md +++ b/build/docs/ConversationEventTopicMessageMetadata.md @@ -13,4 +13,4 @@ Metadata information about a message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicMessageMetadataContent.md b/build/docs/ConversationEventTopicMessageMetadataContent.md index ffb51ae8b..a48f8957d 100644 --- a/build/docs/ConversationEventTopicMessageMetadataContent.md +++ b/build/docs/ConversationEventTopicMessageMetadataContent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicMessageMetadataEvent.md b/build/docs/ConversationEventTopicMessageMetadataEvent.md index b04a5bb70..1d2a82db8 100644 --- a/build/docs/ConversationEventTopicMessageMetadataEvent.md +++ b/build/docs/ConversationEventTopicMessageMetadataEvent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicMessageSticker.md b/build/docs/ConversationEventTopicMessageSticker.md index 85c4cf9c8..fc04e5d4e 100644 --- a/build/docs/ConversationEventTopicMessageSticker.md +++ b/build/docs/ConversationEventTopicMessageSticker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicObject.md b/build/docs/ConversationEventTopicObject.md index 0aa5e7ba2..92560ffc2 100644 --- a/build/docs/ConversationEventTopicObject.md +++ b/build/docs/ConversationEventTopicObject.md @@ -10,4 +10,4 @@ The number of peer participants from the perspective of the participant in the c -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicParticipant.md b/build/docs/ConversationEventTopicParticipant.md index 63e4900ab..3925835d9 100644 --- a/build/docs/ConversationEventTopicParticipant.md +++ b/build/docs/ConversationEventTopicParticipant.md @@ -50,4 +50,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicPhoneNumberColumn.md b/build/docs/ConversationEventTopicPhoneNumberColumn.md index ee3b4bc66..69ca604de 100644 --- a/build/docs/ConversationEventTopicPhoneNumberColumn.md +++ b/build/docs/ConversationEventTopicPhoneNumberColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicQueueMediaSettings.md b/build/docs/ConversationEventTopicQueueMediaSettings.md index a24200638..5b403d5fa 100644 --- a/build/docs/ConversationEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationEventTopicQueueMediaSettings.md @@ -14,4 +14,4 @@ Represents the queue setting for this media. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicScoredAgent.md b/build/docs/ConversationEventTopicScoredAgent.md index 4a6719386..2b251c5ec 100644 --- a/build/docs/ConversationEventTopicScoredAgent.md +++ b/build/docs/ConversationEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicScreenshare.md b/build/docs/ConversationEventTopicScreenshare.md index 8b350bcc1..b41525c77 100644 --- a/build/docs/ConversationEventTopicScreenshare.md +++ b/build/docs/ConversationEventTopicScreenshare.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicSocialExpression.md b/build/docs/ConversationEventTopicSocialExpression.md index 7dc4b0a66..a1921e7f4 100644 --- a/build/docs/ConversationEventTopicSocialExpression.md +++ b/build/docs/ConversationEventTopicSocialExpression.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicTransferDestination.md b/build/docs/ConversationEventTopicTransferDestination.md index fab7ed850..556cc94e9 100644 --- a/build/docs/ConversationEventTopicTransferDestination.md +++ b/build/docs/ConversationEventTopicTransferDestination.md @@ -12,4 +12,4 @@ Fields identifying the destination of a given conversation command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicTransferInitiator.md b/build/docs/ConversationEventTopicTransferInitiator.md index e2714eef4..d585f8494 100644 --- a/build/docs/ConversationEventTopicTransferInitiator.md +++ b/build/docs/ConversationEventTopicTransferInitiator.md @@ -11,4 +11,4 @@ Fields identifying the initiator of a given conversation command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicTransferModifedBy.md b/build/docs/ConversationEventTopicTransferModifedBy.md index faadf5123..3eacea226 100644 --- a/build/docs/ConversationEventTopicTransferModifedBy.md +++ b/build/docs/ConversationEventTopicTransferModifedBy.md @@ -12,4 +12,4 @@ Fields identifying the entity that updated the command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicTransferResponse.md b/build/docs/ConversationEventTopicTransferResponse.md index ac8ac52d0..802ed523c 100644 --- a/build/docs/ConversationEventTopicTransferResponse.md +++ b/build/docs/ConversationEventTopicTransferResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicUriReference.md b/build/docs/ConversationEventTopicUriReference.md index 96ba9e2bd..2a1a0e1eb 100644 --- a/build/docs/ConversationEventTopicUriReference.md +++ b/build/docs/ConversationEventTopicUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicVideo.md b/build/docs/ConversationEventTopicVideo.md index c40b3698b..3dc108514 100644 --- a/build/docs/ConversationEventTopicVideo.md +++ b/build/docs/ConversationEventTopicVideo.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicVoicemail.md b/build/docs/ConversationEventTopicVoicemail.md index fb414aabd..e1bc218f4 100644 --- a/build/docs/ConversationEventTopicVoicemail.md +++ b/build/docs/ConversationEventTopicVoicemail.md @@ -12,4 +12,4 @@ The voicemail data to be used when this callback is an ACD voicemail. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicWorkflow.md b/build/docs/ConversationEventTopicWorkflow.md index 151db5599..60c2c2d3e 100644 --- a/build/docs/ConversationEventTopicWorkflow.md +++ b/build/docs/ConversationEventTopicWorkflow.md @@ -11,4 +11,4 @@ Information about the workflow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTopicWrapup.md b/build/docs/ConversationEventTopicWrapup.md index cb42a6cb3..1e67ca15e 100644 --- a/build/docs/ConversationEventTopicWrapup.md +++ b/build/docs/ConversationEventTopicWrapup.md @@ -15,4 +15,4 @@ Call wrap up or disposition data. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventTyping.md b/build/docs/ConversationEventTyping.md index 6f8e5628c..41c35b3be 100644 --- a/build/docs/ConversationEventTyping.md +++ b/build/docs/ConversationEventTyping.md @@ -12,4 +12,4 @@ A Typing event. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationEventVideo.md b/build/docs/ConversationEventVideo.md index fa71b9a25..e102bd6eb 100644 --- a/build/docs/ConversationEventVideo.md +++ b/build/docs/ConversationEventVideo.md @@ -13,4 +13,4 @@ A Video event. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageContent.md b/build/docs/ConversationMessageContent.md index 74e982de9..71d826cd7 100644 --- a/build/docs/ConversationMessageContent.md +++ b/build/docs/ConversationMessageContent.md @@ -21,4 +21,4 @@ Message content element. If contentType = \"Attachment\" only one -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEvent.md b/build/docs/ConversationMessageEvent.md index 38d2cbb95..95e33d75b 100644 --- a/build/docs/ConversationMessageEvent.md +++ b/build/docs/ConversationMessageEvent.md @@ -15,4 +15,4 @@ Message event element. Examples include: system messages, typing indicators, co -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicConversationDivisionMembership.md b/build/docs/ConversationMessageEventTopicConversationDivisionMembership.md index 40683b4b9..d904de129 100644 --- a/build/docs/ConversationMessageEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationMessageEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicConversationRoutingData.md b/build/docs/ConversationMessageEventTopicConversationRoutingData.md index 7eeb56e82..b1b10b82d 100644 --- a/build/docs/ConversationMessageEventTopicConversationRoutingData.md +++ b/build/docs/ConversationMessageEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicDetail.md b/build/docs/ConversationMessageEventTopicDetail.md index e9d26118c..0d380f95a 100644 --- a/build/docs/ConversationMessageEventTopicDetail.md +++ b/build/docs/ConversationMessageEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicDivisionEntityRef.md b/build/docs/ConversationMessageEventTopicDivisionEntityRef.md index 664a3fd33..b56de8530 100644 --- a/build/docs/ConversationMessageEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationMessageEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicDomainEntityRef.md b/build/docs/ConversationMessageEventTopicDomainEntityRef.md index ec73c059c..497ca62f2 100644 --- a/build/docs/ConversationMessageEventTopicDomainEntityRef.md +++ b/build/docs/ConversationMessageEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicErrorBody.md b/build/docs/ConversationMessageEventTopicErrorBody.md index ae4a553ee..6ced44722 100644 --- a/build/docs/ConversationMessageEventTopicErrorBody.md +++ b/build/docs/ConversationMessageEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicErrorDetails.md b/build/docs/ConversationMessageEventTopicErrorDetails.md index e1a537a35..f48a83999 100644 --- a/build/docs/ConversationMessageEventTopicErrorDetails.md +++ b/build/docs/ConversationMessageEventTopicErrorDetails.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicJourneyAction.md b/build/docs/ConversationMessageEventTopicJourneyAction.md index 183196eaa..f13fb523f 100644 --- a/build/docs/ConversationMessageEventTopicJourneyAction.md +++ b/build/docs/ConversationMessageEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicJourneyActionMap.md b/build/docs/ConversationMessageEventTopicJourneyActionMap.md index 9d6240a12..f7cb6ebc5 100644 --- a/build/docs/ConversationMessageEventTopicJourneyActionMap.md +++ b/build/docs/ConversationMessageEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicJourneyContext.md b/build/docs/ConversationMessageEventTopicJourneyContext.md index 92db8dd48..76e14d15d 100644 --- a/build/docs/ConversationMessageEventTopicJourneyContext.md +++ b/build/docs/ConversationMessageEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicJourneyCustomer.md b/build/docs/ConversationMessageEventTopicJourneyCustomer.md index 460d6e782..44c92e935 100644 --- a/build/docs/ConversationMessageEventTopicJourneyCustomer.md +++ b/build/docs/ConversationMessageEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicJourneyCustomerSession.md b/build/docs/ConversationMessageEventTopicJourneyCustomerSession.md index cc28a874f..d843202f5 100644 --- a/build/docs/ConversationMessageEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationMessageEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicLimit.md b/build/docs/ConversationMessageEventTopicLimit.md index cd9918dca..8446f3a44 100644 --- a/build/docs/ConversationMessageEventTopicLimit.md +++ b/build/docs/ConversationMessageEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicMessageConversation.md b/build/docs/ConversationMessageEventTopicMessageConversation.md index 81cf77a56..09b3d6695 100644 --- a/build/docs/ConversationMessageEventTopicMessageConversation.md +++ b/build/docs/ConversationMessageEventTopicMessageConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicMessageDetails.md b/build/docs/ConversationMessageEventTopicMessageDetails.md index 15c37dae4..fe3535be4 100644 --- a/build/docs/ConversationMessageEventTopicMessageDetails.md +++ b/build/docs/ConversationMessageEventTopicMessageDetails.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicMessageMedia.md b/build/docs/ConversationMessageEventTopicMessageMedia.md index 9c9ec9a9b..be552c79f 100644 --- a/build/docs/ConversationMessageEventTopicMessageMedia.md +++ b/build/docs/ConversationMessageEventTopicMessageMedia.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicMessageMediaParticipant.md b/build/docs/ConversationMessageEventTopicMessageMediaParticipant.md index 79e503b21..08c9d3f9b 100644 --- a/build/docs/ConversationMessageEventTopicMessageMediaParticipant.md +++ b/build/docs/ConversationMessageEventTopicMessageMediaParticipant.md @@ -55,4 +55,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicMessageMetadata.md b/build/docs/ConversationMessageEventTopicMessageMetadata.md index 6b83db652..7d3e851d0 100644 --- a/build/docs/ConversationMessageEventTopicMessageMetadata.md +++ b/build/docs/ConversationMessageEventTopicMessageMetadata.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicMessageMetadataContent.md b/build/docs/ConversationMessageEventTopicMessageMetadataContent.md index e3e50d682..74b74bea6 100644 --- a/build/docs/ConversationMessageEventTopicMessageMetadataContent.md +++ b/build/docs/ConversationMessageEventTopicMessageMetadataContent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicMessageMetadataEvent.md b/build/docs/ConversationMessageEventTopicMessageMetadataEvent.md index b2f92538d..9b3cddd35 100644 --- a/build/docs/ConversationMessageEventTopicMessageMetadataEvent.md +++ b/build/docs/ConversationMessageEventTopicMessageMetadataEvent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicMessageSticker.md b/build/docs/ConversationMessageEventTopicMessageSticker.md index 44cc74f64..29bc05c5c 100644 --- a/build/docs/ConversationMessageEventTopicMessageSticker.md +++ b/build/docs/ConversationMessageEventTopicMessageSticker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicQueueMediaSettings.md b/build/docs/ConversationMessageEventTopicQueueMediaSettings.md index fd2d00d3d..88e15963e 100644 --- a/build/docs/ConversationMessageEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationMessageEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicScoredAgent.md b/build/docs/ConversationMessageEventTopicScoredAgent.md index 568d51cab..3f75c8d70 100644 --- a/build/docs/ConversationMessageEventTopicScoredAgent.md +++ b/build/docs/ConversationMessageEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicUriReference.md b/build/docs/ConversationMessageEventTopicUriReference.md index 5face6428..9c9a5469f 100644 --- a/build/docs/ConversationMessageEventTopicUriReference.md +++ b/build/docs/ConversationMessageEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageEventTopicWrapup.md b/build/docs/ConversationMessageEventTopicWrapup.md index 185fd4ad5..12a02b9c8 100644 --- a/build/docs/ConversationMessageEventTopicWrapup.md +++ b/build/docs/ConversationMessageEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageMetadata.md b/build/docs/ConversationMessageMetadata.md index 7eeb3a3b7..1be512ccc 100644 --- a/build/docs/ConversationMessageMetadata.md +++ b/build/docs/ConversationMessageMetadata.md @@ -13,4 +13,4 @@ Metadata information about a message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageMetadataContent.md b/build/docs/ConversationMessageMetadataContent.md index bc4d4b526..359cf1fbf 100644 --- a/build/docs/ConversationMessageMetadataContent.md +++ b/build/docs/ConversationMessageMetadataContent.md @@ -12,4 +12,4 @@ Metadata information about a message content. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessageMetadataEvent.md b/build/docs/ConversationMessageMetadataEvent.md index 299afa50c..61c696a86 100644 --- a/build/docs/ConversationMessageMetadataEvent.md +++ b/build/docs/ConversationMessageMetadataEvent.md @@ -12,4 +12,4 @@ Metadata information about a message event. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessagingChannel.md b/build/docs/ConversationMessagingChannel.md index 5d346ae06..31c73bed7 100644 --- a/build/docs/ConversationMessagingChannel.md +++ b/build/docs/ConversationMessagingChannel.md @@ -18,4 +18,4 @@ Channel-specific information that describes the message and the message channel/ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessagingFromRecipient.md b/build/docs/ConversationMessagingFromRecipient.md index c561c87f7..017a0f694 100644 --- a/build/docs/ConversationMessagingFromRecipient.md +++ b/build/docs/ConversationMessagingFromRecipient.md @@ -19,4 +19,4 @@ Information about the recipient the message is received from. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMessagingToRecipient.md b/build/docs/ConversationMessagingToRecipient.md index b146ea57b..effd1fd4a 100644 --- a/build/docs/ConversationMessagingToRecipient.md +++ b/build/docs/ConversationMessagingToRecipient.md @@ -19,4 +19,4 @@ Information about the recipient the message is sent to. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMetrics.md b/build/docs/ConversationMetrics.md index 4d3db2128..85ea83199 100644 --- a/build/docs/ConversationMetrics.md +++ b/build/docs/ConversationMetrics.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMetricsTopicConversationMetricRecord.md b/build/docs/ConversationMetricsTopicConversationMetricRecord.md index 0419747c2..03a03b6c1 100644 --- a/build/docs/ConversationMetricsTopicConversationMetricRecord.md +++ b/build/docs/ConversationMetricsTopicConversationMetricRecord.md @@ -93,4 +93,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMetricsTopicConversationProposedAgent.md b/build/docs/ConversationMetricsTopicConversationProposedAgent.md index 22758510a..9c68a1f77 100644 --- a/build/docs/ConversationMetricsTopicConversationProposedAgent.md +++ b/build/docs/ConversationMetricsTopicConversationProposedAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationMetricsTopicConversationScoredAgent.md b/build/docs/ConversationMetricsTopicConversationScoredAgent.md index f5177dccb..beb932ad9 100644 --- a/build/docs/ConversationMetricsTopicConversationScoredAgent.md +++ b/build/docs/ConversationMetricsTopicConversationScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationNormalizedMessage.md b/build/docs/ConversationNormalizedMessage.md index f7733d8e3..27eb26af0 100644 --- a/build/docs/ConversationNormalizedMessage.md +++ b/build/docs/ConversationNormalizedMessage.md @@ -23,4 +23,4 @@ General rich media message structure with normalized feature support across many -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationNotificationTemplateBody.md b/build/docs/ConversationNotificationTemplateBody.md index 4896d714d..c3453c85f 100644 --- a/build/docs/ConversationNotificationTemplateBody.md +++ b/build/docs/ConversationNotificationTemplateBody.md @@ -12,4 +12,4 @@ Template body object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationNotificationTemplateButton.md b/build/docs/ConversationNotificationTemplateButton.md index 3f9c83a56..b03c80c00 100644 --- a/build/docs/ConversationNotificationTemplateButton.md +++ b/build/docs/ConversationNotificationTemplateButton.md @@ -16,4 +16,4 @@ Template button object -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationNotificationTemplateFooter.md b/build/docs/ConversationNotificationTemplateFooter.md index 8a8cf79eb..803caa004 100644 --- a/build/docs/ConversationNotificationTemplateFooter.md +++ b/build/docs/ConversationNotificationTemplateFooter.md @@ -11,4 +11,4 @@ Template footer object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationNotificationTemplateHeader.md b/build/docs/ConversationNotificationTemplateHeader.md index 1e6136a2a..9ff312756 100644 --- a/build/docs/ConversationNotificationTemplateHeader.md +++ b/build/docs/ConversationNotificationTemplateHeader.md @@ -14,4 +14,4 @@ Template header object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationNotificationTemplateParameter.md b/build/docs/ConversationNotificationTemplateParameter.md index cb7b8ad3d..c534dc8a7 100644 --- a/build/docs/ConversationNotificationTemplateParameter.md +++ b/build/docs/ConversationNotificationTemplateParameter.md @@ -12,4 +12,4 @@ Template parameters for placeholders in template. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationParticipantSearchCriteria.md b/build/docs/ConversationParticipantSearchCriteria.md index 8a78026ca..0d3879b1d 100644 --- a/build/docs/ConversationParticipantSearchCriteria.md +++ b/build/docs/ConversationParticipantSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationParticipantSearchRequest.md b/build/docs/ConversationParticipantSearchRequest.md index 719fe3b7c..0f1bd06d0 100644 --- a/build/docs/ConversationParticipantSearchRequest.md +++ b/build/docs/ConversationParticipantSearchRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationProfile.md b/build/docs/ConversationProfile.md index ec0132142..83335e478 100644 --- a/build/docs/ConversationProfile.md +++ b/build/docs/ConversationProfile.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationProperties.md b/build/docs/ConversationProperties.md index 2c8403b5f..208d930dd 100644 --- a/build/docs/ConversationProperties.md +++ b/build/docs/ConversationProperties.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationPublicMetadata.md b/build/docs/ConversationPublicMetadata.md index 6e2da92f1..043bac72d 100644 --- a/build/docs/ConversationPublicMetadata.md +++ b/build/docs/ConversationPublicMetadata.md @@ -12,4 +12,4 @@ Information about a public message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationQuery.md b/build/docs/ConversationQuery.md index 2c3b849cc..c02a1f7a6 100644 --- a/build/docs/ConversationQuery.md +++ b/build/docs/ConversationQuery.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationQueueMediaSettings.md b/build/docs/ConversationQueueMediaSettings.md index b3869f635..a4cca8fc2 100644 --- a/build/docs/ConversationQueueMediaSettings.md +++ b/build/docs/ConversationQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationReason.md b/build/docs/ConversationReason.md index 18236085f..6a5179392 100644 --- a/build/docs/ConversationReason.md +++ b/build/docs/ConversationReason.md @@ -12,4 +12,4 @@ Reasons for a failed message receipt. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationRecipientAdditionalIdentifier.md b/build/docs/ConversationRecipientAdditionalIdentifier.md index d7d234182..9f5d3a145 100644 --- a/build/docs/ConversationRecipientAdditionalIdentifier.md +++ b/build/docs/ConversationRecipientAdditionalIdentifier.md @@ -12,4 +12,4 @@ Additional identifiers for describing messaging recipient. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationReference.md b/build/docs/ConversationReference.md index 232f49f39..c7c2377ab 100644 --- a/build/docs/ConversationReference.md +++ b/build/docs/ConversationReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationRoutingData.md b/build/docs/ConversationRoutingData.md index 81ba3ea86..1a83d799b 100644 --- a/build/docs/ConversationRoutingData.md +++ b/build/docs/ConversationRoutingData.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicConversationDivisionMembership.md b/build/docs/ConversationScreenShareEventTopicConversationDivisionMembership.md index a8d7ad4c7..61ff3ef97 100644 --- a/build/docs/ConversationScreenShareEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationScreenShareEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicConversationRoutingData.md b/build/docs/ConversationScreenShareEventTopicConversationRoutingData.md index 2daacd09a..90956177b 100644 --- a/build/docs/ConversationScreenShareEventTopicConversationRoutingData.md +++ b/build/docs/ConversationScreenShareEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicDetail.md b/build/docs/ConversationScreenShareEventTopicDetail.md index 96f3504a7..38d242ed3 100644 --- a/build/docs/ConversationScreenShareEventTopicDetail.md +++ b/build/docs/ConversationScreenShareEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicDivisionEntityRef.md b/build/docs/ConversationScreenShareEventTopicDivisionEntityRef.md index b32218c31..60751da71 100644 --- a/build/docs/ConversationScreenShareEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationScreenShareEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicDomainEntityRef.md b/build/docs/ConversationScreenShareEventTopicDomainEntityRef.md index 62bbfa8f5..e912c2d45 100644 --- a/build/docs/ConversationScreenShareEventTopicDomainEntityRef.md +++ b/build/docs/ConversationScreenShareEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicErrorBody.md b/build/docs/ConversationScreenShareEventTopicErrorBody.md index 4de43f8a9..4e486b49e 100644 --- a/build/docs/ConversationScreenShareEventTopicErrorBody.md +++ b/build/docs/ConversationScreenShareEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicJourneyAction.md b/build/docs/ConversationScreenShareEventTopicJourneyAction.md index 4afa4b536..a932b36a2 100644 --- a/build/docs/ConversationScreenShareEventTopicJourneyAction.md +++ b/build/docs/ConversationScreenShareEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicJourneyActionMap.md b/build/docs/ConversationScreenShareEventTopicJourneyActionMap.md index d6d69a4fa..c399fd56d 100644 --- a/build/docs/ConversationScreenShareEventTopicJourneyActionMap.md +++ b/build/docs/ConversationScreenShareEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicJourneyContext.md b/build/docs/ConversationScreenShareEventTopicJourneyContext.md index 587588e4b..66aaa0c2b 100644 --- a/build/docs/ConversationScreenShareEventTopicJourneyContext.md +++ b/build/docs/ConversationScreenShareEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicJourneyCustomer.md b/build/docs/ConversationScreenShareEventTopicJourneyCustomer.md index 77bf5feed..ce142fb60 100644 --- a/build/docs/ConversationScreenShareEventTopicJourneyCustomer.md +++ b/build/docs/ConversationScreenShareEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicJourneyCustomerSession.md b/build/docs/ConversationScreenShareEventTopicJourneyCustomerSession.md index 5e20bf12c..7b38208af 100644 --- a/build/docs/ConversationScreenShareEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationScreenShareEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicLimit.md b/build/docs/ConversationScreenShareEventTopicLimit.md index 06a5126fb..48cc52fc3 100644 --- a/build/docs/ConversationScreenShareEventTopicLimit.md +++ b/build/docs/ConversationScreenShareEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicQueueMediaSettings.md b/build/docs/ConversationScreenShareEventTopicQueueMediaSettings.md index ea59a4087..a8fc88498 100644 --- a/build/docs/ConversationScreenShareEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationScreenShareEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicScoredAgent.md b/build/docs/ConversationScreenShareEventTopicScoredAgent.md index db23314ec..d5f317d4a 100644 --- a/build/docs/ConversationScreenShareEventTopicScoredAgent.md +++ b/build/docs/ConversationScreenShareEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicScreenShareConversation.md b/build/docs/ConversationScreenShareEventTopicScreenShareConversation.md index 90529a004..d9efe4b2f 100644 --- a/build/docs/ConversationScreenShareEventTopicScreenShareConversation.md +++ b/build/docs/ConversationScreenShareEventTopicScreenShareConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md b/build/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md index 1f40b6f6b..8443a9a40 100644 --- a/build/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md +++ b/build/docs/ConversationScreenShareEventTopicScreenShareMediaParticipant.md @@ -52,4 +52,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicUriReference.md b/build/docs/ConversationScreenShareEventTopicUriReference.md index 34d7a9e4f..5b5ba8e4d 100644 --- a/build/docs/ConversationScreenShareEventTopicUriReference.md +++ b/build/docs/ConversationScreenShareEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationScreenShareEventTopicWrapup.md b/build/docs/ConversationScreenShareEventTopicWrapup.md index 950d4d24d..f3295a3c8 100644 --- a/build/docs/ConversationScreenShareEventTopicWrapup.md +++ b/build/docs/ConversationScreenShareEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSecureAttributes.md b/build/docs/ConversationSecureAttributes.md index 9109b6d55..fce79a5b8 100644 --- a/build/docs/ConversationSecureAttributes.md +++ b/build/docs/ConversationSecureAttributes.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSessionSummary.md b/build/docs/ConversationSessionSummary.md index d406a9b93..ef701be28 100644 --- a/build/docs/ConversationSessionSummary.md +++ b/build/docs/ConversationSessionSummary.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicConversationDivisionMembership.md b/build/docs/ConversationSocialExpressionEventTopicConversationDivisionMembership.md index d48c13d20..f3acc32f4 100644 --- a/build/docs/ConversationSocialExpressionEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationSocialExpressionEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicConversationRoutingData.md b/build/docs/ConversationSocialExpressionEventTopicConversationRoutingData.md index 4c4478451..a3de1e580 100644 --- a/build/docs/ConversationSocialExpressionEventTopicConversationRoutingData.md +++ b/build/docs/ConversationSocialExpressionEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicDetail.md b/build/docs/ConversationSocialExpressionEventTopicDetail.md index 885dcf375..65af436c9 100644 --- a/build/docs/ConversationSocialExpressionEventTopicDetail.md +++ b/build/docs/ConversationSocialExpressionEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicDivisionEntityRef.md b/build/docs/ConversationSocialExpressionEventTopicDivisionEntityRef.md index e1a71511b..2677e2883 100644 --- a/build/docs/ConversationSocialExpressionEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationSocialExpressionEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicDomainEntityRef.md b/build/docs/ConversationSocialExpressionEventTopicDomainEntityRef.md index 00d42a8e8..9c50866c4 100644 --- a/build/docs/ConversationSocialExpressionEventTopicDomainEntityRef.md +++ b/build/docs/ConversationSocialExpressionEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicErrorBody.md b/build/docs/ConversationSocialExpressionEventTopicErrorBody.md index 3409b9459..aa4b7732e 100644 --- a/build/docs/ConversationSocialExpressionEventTopicErrorBody.md +++ b/build/docs/ConversationSocialExpressionEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicJourneyAction.md b/build/docs/ConversationSocialExpressionEventTopicJourneyAction.md index 6dedd1325..ecf699869 100644 --- a/build/docs/ConversationSocialExpressionEventTopicJourneyAction.md +++ b/build/docs/ConversationSocialExpressionEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicJourneyActionMap.md b/build/docs/ConversationSocialExpressionEventTopicJourneyActionMap.md index fda39cf36..483f2f166 100644 --- a/build/docs/ConversationSocialExpressionEventTopicJourneyActionMap.md +++ b/build/docs/ConversationSocialExpressionEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicJourneyContext.md b/build/docs/ConversationSocialExpressionEventTopicJourneyContext.md index 00d1c552d..75051d659 100644 --- a/build/docs/ConversationSocialExpressionEventTopicJourneyContext.md +++ b/build/docs/ConversationSocialExpressionEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicJourneyCustomer.md b/build/docs/ConversationSocialExpressionEventTopicJourneyCustomer.md index e640e7c9e..1564834c3 100644 --- a/build/docs/ConversationSocialExpressionEventTopicJourneyCustomer.md +++ b/build/docs/ConversationSocialExpressionEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicJourneyCustomerSession.md b/build/docs/ConversationSocialExpressionEventTopicJourneyCustomerSession.md index 0a28df8ea..e8589639d 100644 --- a/build/docs/ConversationSocialExpressionEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationSocialExpressionEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicLimit.md b/build/docs/ConversationSocialExpressionEventTopicLimit.md index ad3cb5568..84efa5869 100644 --- a/build/docs/ConversationSocialExpressionEventTopicLimit.md +++ b/build/docs/ConversationSocialExpressionEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicQueueMediaSettings.md b/build/docs/ConversationSocialExpressionEventTopicQueueMediaSettings.md index 5890aada6..6191b8dd4 100644 --- a/build/docs/ConversationSocialExpressionEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationSocialExpressionEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicScoredAgent.md b/build/docs/ConversationSocialExpressionEventTopicScoredAgent.md index 6b54a9996..ac3d50abb 100644 --- a/build/docs/ConversationSocialExpressionEventTopicScoredAgent.md +++ b/build/docs/ConversationSocialExpressionEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicSocialConversation.md b/build/docs/ConversationSocialExpressionEventTopicSocialConversation.md index a4f0529e6..e44e2645e 100644 --- a/build/docs/ConversationSocialExpressionEventTopicSocialConversation.md +++ b/build/docs/ConversationSocialExpressionEventTopicSocialConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md b/build/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md index df936ad25..828ace5d3 100644 --- a/build/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md +++ b/build/docs/ConversationSocialExpressionEventTopicSocialMediaParticipant.md @@ -53,4 +53,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicUriReference.md b/build/docs/ConversationSocialExpressionEventTopicUriReference.md index 3fc847694..1ec09c4d8 100644 --- a/build/docs/ConversationSocialExpressionEventTopicUriReference.md +++ b/build/docs/ConversationSocialExpressionEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSocialExpressionEventTopicWrapup.md b/build/docs/ConversationSocialExpressionEventTopicWrapup.md index 4cbf51952..d5c26ac6a 100644 --- a/build/docs/ConversationSocialExpressionEventTopicWrapup.md +++ b/build/docs/ConversationSocialExpressionEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummariesGetResponse.md b/build/docs/ConversationSummariesGetResponse.md index 76d660d46..7f3d8bc92 100644 --- a/build/docs/ConversationSummariesGetResponse.md +++ b/build/docs/ConversationSummariesGetResponse.md @@ -13,4 +13,4 @@ Defines the summaries of a conversation. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummary.md b/build/docs/ConversationSummary.md index 3e3caa1c4..656af5e92 100644 --- a/build/docs/ConversationSummary.md +++ b/build/docs/ConversationSummary.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryFollowup.md b/build/docs/ConversationSummaryFollowup.md index 3f5b5d329..1d1a8c68e 100644 --- a/build/docs/ConversationSummaryFollowup.md +++ b/build/docs/ConversationSummaryFollowup.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryReason.md b/build/docs/ConversationSummaryReason.md index 3ed65d1cb..9c26c0f4a 100644 --- a/build/docs/ConversationSummaryReason.md +++ b/build/docs/ConversationSummaryReason.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryResolution.md b/build/docs/ConversationSummaryResolution.md index 5c347dd3b..b5a73f899 100644 --- a/build/docs/ConversationSummaryResolution.md +++ b/build/docs/ConversationSummaryResolution.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryTopicVirtualAgentsConversationHeadline.md b/build/docs/ConversationSummaryTopicVirtualAgentsConversationHeadline.md index 084afab2f..141c52fe6 100644 --- a/build/docs/ConversationSummaryTopicVirtualAgentsConversationHeadline.md +++ b/build/docs/ConversationSummaryTopicVirtualAgentsConversationHeadline.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryTopicVirtualAgentsConversationReason.md b/build/docs/ConversationSummaryTopicVirtualAgentsConversationReason.md index 0dd8c4b43..390cb2849 100644 --- a/build/docs/ConversationSummaryTopicVirtualAgentsConversationReason.md +++ b/build/docs/ConversationSummaryTopicVirtualAgentsConversationReason.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryTopicVirtualAgentsConversationResolution.md b/build/docs/ConversationSummaryTopicVirtualAgentsConversationResolution.md index a1bc4c755..fb5679c54 100644 --- a/build/docs/ConversationSummaryTopicVirtualAgentsConversationResolution.md +++ b/build/docs/ConversationSummaryTopicVirtualAgentsConversationResolution.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummary.md b/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummary.md index 8ef6b5f98..6ea275123 100644 --- a/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummary.md +++ b/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummary.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummaryEvent.md b/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummaryEvent.md index 4ac01e5de..d4106a9cb 100644 --- a/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummaryEvent.md +++ b/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummaryEvent.md @@ -22,7 +22,8 @@ | **triggerSource** | [**ConversationSummaryTopicVirtualAgentsTriggerSource**](ConversationSummaryTopicVirtualAgentsTriggerSource) | | [optional] | | **lastEditedBy** | [**ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant**](ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant) | | [optional] | | **errorType** | **String** | | [optional] | +| **durationMs** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant.md b/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant.md index aa50fcd84..13c1763e5 100644 --- a/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant.md +++ b/build/docs/ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryTopicVirtualAgentsConversationWrapUpCode.md b/build/docs/ConversationSummaryTopicVirtualAgentsConversationWrapUpCode.md index d8b260dbd..8c7771596 100644 --- a/build/docs/ConversationSummaryTopicVirtualAgentsConversationWrapUpCode.md +++ b/build/docs/ConversationSummaryTopicVirtualAgentsConversationWrapUpCode.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryTopicVirtualAgentsTriggerSource.md b/build/docs/ConversationSummaryTopicVirtualAgentsTriggerSource.md index 9c8344cc5..8fd6d571d 100644 --- a/build/docs/ConversationSummaryTopicVirtualAgentsTriggerSource.md +++ b/build/docs/ConversationSummaryTopicVirtualAgentsTriggerSource.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationSummaryWrapupCode.md b/build/docs/ConversationSummaryWrapupCode.md index cd56a5bb0..71114cdad 100644 --- a/build/docs/ConversationSummaryWrapupCode.md +++ b/build/docs/ConversationSummaryWrapupCode.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationTagsUpdate.md b/build/docs/ConversationTagsUpdate.md index 97497832c..c1bb45cd1 100644 --- a/build/docs/ConversationTagsUpdate.md +++ b/build/docs/ConversationTagsUpdate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationThreadingWindow.md b/build/docs/ConversationThreadingWindow.md index 57a42676b..26d2a6e64 100644 --- a/build/docs/ConversationThreadingWindow.md +++ b/build/docs/ConversationThreadingWindow.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationThreadingWindowSetting.md b/build/docs/ConversationThreadingWindowSetting.md index 02d3fa618..df1268ad3 100644 --- a/build/docs/ConversationThreadingWindowSetting.md +++ b/build/docs/ConversationThreadingWindowSetting.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationUser.md b/build/docs/ConversationUser.md index 59ed8253b..d7642adbc 100644 --- a/build/docs/ConversationUser.md +++ b/build/docs/ConversationUser.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationUserDisposition.md b/build/docs/ConversationUserDisposition.md index 5cee470d8..94c88768c 100644 --- a/build/docs/ConversationUserDisposition.md +++ b/build/docs/ConversationUserDisposition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationUtilizationLabelUpdate.md b/build/docs/ConversationUtilizationLabelUpdate.md index 91d2b0988..646883722 100644 --- a/build/docs/ConversationUtilizationLabelUpdate.md +++ b/build/docs/ConversationUtilizationLabelUpdate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicConversationDivisionMembership.md b/build/docs/ConversationVideoEventTopicConversationDivisionMembership.md index 4821a1752..e5d968ef2 100644 --- a/build/docs/ConversationVideoEventTopicConversationDivisionMembership.md +++ b/build/docs/ConversationVideoEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicConversationRoutingData.md b/build/docs/ConversationVideoEventTopicConversationRoutingData.md index 0f2e3df47..424688905 100644 --- a/build/docs/ConversationVideoEventTopicConversationRoutingData.md +++ b/build/docs/ConversationVideoEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicDetail.md b/build/docs/ConversationVideoEventTopicDetail.md index a56d8a5aa..5259c2bc2 100644 --- a/build/docs/ConversationVideoEventTopicDetail.md +++ b/build/docs/ConversationVideoEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicDivisionEntityRef.md b/build/docs/ConversationVideoEventTopicDivisionEntityRef.md index 4c24badf4..21b80ec1d 100644 --- a/build/docs/ConversationVideoEventTopicDivisionEntityRef.md +++ b/build/docs/ConversationVideoEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicDomainEntityRef.md b/build/docs/ConversationVideoEventTopicDomainEntityRef.md index a0ad617c3..db740460c 100644 --- a/build/docs/ConversationVideoEventTopicDomainEntityRef.md +++ b/build/docs/ConversationVideoEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicErrorBody.md b/build/docs/ConversationVideoEventTopicErrorBody.md index b65874a9c..18a48c3a6 100644 --- a/build/docs/ConversationVideoEventTopicErrorBody.md +++ b/build/docs/ConversationVideoEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicJourneyAction.md b/build/docs/ConversationVideoEventTopicJourneyAction.md index 6bab16fe1..6a961a17a 100644 --- a/build/docs/ConversationVideoEventTopicJourneyAction.md +++ b/build/docs/ConversationVideoEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicJourneyActionMap.md b/build/docs/ConversationVideoEventTopicJourneyActionMap.md index 642b9f66c..2db73573c 100644 --- a/build/docs/ConversationVideoEventTopicJourneyActionMap.md +++ b/build/docs/ConversationVideoEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicJourneyContext.md b/build/docs/ConversationVideoEventTopicJourneyContext.md index 89827b137..e20f14617 100644 --- a/build/docs/ConversationVideoEventTopicJourneyContext.md +++ b/build/docs/ConversationVideoEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicJourneyCustomer.md b/build/docs/ConversationVideoEventTopicJourneyCustomer.md index e04e38bb0..f4ff25a73 100644 --- a/build/docs/ConversationVideoEventTopicJourneyCustomer.md +++ b/build/docs/ConversationVideoEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicJourneyCustomerSession.md b/build/docs/ConversationVideoEventTopicJourneyCustomerSession.md index 2437b4643..aff636a01 100644 --- a/build/docs/ConversationVideoEventTopicJourneyCustomerSession.md +++ b/build/docs/ConversationVideoEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicLimit.md b/build/docs/ConversationVideoEventTopicLimit.md index 7a3ce9eac..27a18ec77 100644 --- a/build/docs/ConversationVideoEventTopicLimit.md +++ b/build/docs/ConversationVideoEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicQueueMediaSettings.md b/build/docs/ConversationVideoEventTopicQueueMediaSettings.md index 511d75918..fb8d07e42 100644 --- a/build/docs/ConversationVideoEventTopicQueueMediaSettings.md +++ b/build/docs/ConversationVideoEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicScoredAgent.md b/build/docs/ConversationVideoEventTopicScoredAgent.md index 20a3978d6..d1bde591e 100644 --- a/build/docs/ConversationVideoEventTopicScoredAgent.md +++ b/build/docs/ConversationVideoEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicUriReference.md b/build/docs/ConversationVideoEventTopicUriReference.md index 356f1ebb2..71ec90e5c 100644 --- a/build/docs/ConversationVideoEventTopicUriReference.md +++ b/build/docs/ConversationVideoEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicVideoConversation.md b/build/docs/ConversationVideoEventTopicVideoConversation.md index b47683b71..bacf21b64 100644 --- a/build/docs/ConversationVideoEventTopicVideoConversation.md +++ b/build/docs/ConversationVideoEventTopicVideoConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicVideoMediaParticipant.md b/build/docs/ConversationVideoEventTopicVideoMediaParticipant.md index ce19a927c..db6957082 100644 --- a/build/docs/ConversationVideoEventTopicVideoMediaParticipant.md +++ b/build/docs/ConversationVideoEventTopicVideoMediaParticipant.md @@ -55,4 +55,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationVideoEventTopicWrapup.md b/build/docs/ConversationVideoEventTopicWrapup.md index 395df8247..0f0df921a 100644 --- a/build/docs/ConversationVideoEventTopicWrapup.md +++ b/build/docs/ConversationVideoEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ConversationsAPI.md b/build/docs/ConversationsAPI.md index 818d265ca..8beace01d 100644 --- a/build/docs/ConversationsAPI.md +++ b/build/docs/ConversationsAPI.md @@ -12339,4 +12339,4 @@ ConversationsAPI.putConversationsVideoRecordingstate(conversationId: conversatio **String** -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Copilot.md b/build/docs/Copilot.md index 9469f4dd8..0ce96c269 100644 --- a/build/docs/Copilot.md +++ b/build/docs/Copilot.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopilotAction.md b/build/docs/CopilotAction.md index 7d0ca14a3..726d49565 100644 --- a/build/docs/CopilotAction.md +++ b/build/docs/CopilotAction.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopilotCondition.md b/build/docs/CopilotCondition.md index 5e955fe51..dd1561801 100644 --- a/build/docs/CopilotCondition.md +++ b/build/docs/CopilotCondition.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopilotFallbackAction.md b/build/docs/CopilotFallbackAction.md index 147b4de5b..ebdc89066 100644 --- a/build/docs/CopilotFallbackAction.md +++ b/build/docs/CopilotFallbackAction.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopilotNluDomain.md b/build/docs/CopilotNluDomain.md index 3d0904abb..eb3f79f16 100644 --- a/build/docs/CopilotNluDomain.md +++ b/build/docs/CopilotNluDomain.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopilotNluDomainVersion.md b/build/docs/CopilotNluDomainVersion.md index 4a110c3a4..94e6d2376 100644 --- a/build/docs/CopilotNluDomainVersion.md +++ b/build/docs/CopilotNluDomainVersion.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopilotRule.md b/build/docs/CopilotRule.md index 72ddc6e2d..3530a5f81 100644 --- a/build/docs/CopilotRule.md +++ b/build/docs/CopilotRule.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopilotTranscriptionConfig.md b/build/docs/CopilotTranscriptionConfig.md index 31e0cb562..261e58711 100644 --- a/build/docs/CopilotTranscriptionConfig.md +++ b/build/docs/CopilotTranscriptionConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopyAttachmentsRequest.md b/build/docs/CopyAttachmentsRequest.md index 525b8f5c3..3ecd6c6e6 100644 --- a/build/docs/CopyAttachmentsRequest.md +++ b/build/docs/CopyAttachmentsRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopyBuForecastRequest.md b/build/docs/CopyBuForecastRequest.md index 5497865d8..9dcc7837d 100644 --- a/build/docs/CopyBuForecastRequest.md +++ b/build/docs/CopyBuForecastRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopyVoicemailMessage.md b/build/docs/CopyVoicemailMessage.md index 04a009e3c..d9374d7db 100644 --- a/build/docs/CopyVoicemailMessage.md +++ b/build/docs/CopyVoicemailMessage.md @@ -13,4 +13,4 @@ Used to copy a VoicemailMessage to either a User or a Group -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopyWorkPlan.md b/build/docs/CopyWorkPlan.md index d567b57c5..5de914d85 100644 --- a/build/docs/CopyWorkPlan.md +++ b/build/docs/CopyWorkPlan.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopyWorkPlanBid.md b/build/docs/CopyWorkPlanBid.md index c83818ed7..74b457345 100644 --- a/build/docs/CopyWorkPlanBid.md +++ b/build/docs/CopyWorkPlanBid.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CopyWorkPlanRotationRequest.md b/build/docs/CopyWorkPlanRotationRequest.md index 73b8aa2a3..3b88cc718 100644 --- a/build/docs/CopyWorkPlanRotationRequest.md +++ b/build/docs/CopyWorkPlanRotationRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Coretype.md b/build/docs/Coretype.md index f3589b47c..ed749c699 100644 --- a/build/docs/Coretype.md +++ b/build/docs/Coretype.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoretypeListing.md b/build/docs/CoretypeListing.md index 9c5d89d39..651b7d3cf 100644 --- a/build/docs/CoretypeListing.md +++ b/build/docs/CoretypeListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CoverSheet.md b/build/docs/CoverSheet.md index 83ab36d8a..520308a39 100644 --- a/build/docs/CoverSheet.md +++ b/build/docs/CoverSheet.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateActivityCodeRequest.md b/build/docs/CreateActivityCodeRequest.md index a9388de18..ee32d3f7d 100644 --- a/build/docs/CreateActivityCodeRequest.md +++ b/build/docs/CreateActivityCodeRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateActivityPlanRequest.md b/build/docs/CreateActivityPlanRequest.md index f32ff6c3c..c1ba6c7c7 100644 --- a/build/docs/CreateActivityPlanRequest.md +++ b/build/docs/CreateActivityPlanRequest.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateAdminTimeOffRequest.md b/build/docs/CreateAdminTimeOffRequest.md index c47284d2f..670c1a932 100644 --- a/build/docs/CreateAdminTimeOffRequest.md +++ b/build/docs/CreateAdminTimeOffRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateAgentTimeOffRequest.md b/build/docs/CreateAgentTimeOffRequest.md index 91ad80184..7e1dd850c 100644 --- a/build/docs/CreateAgentTimeOffRequest.md +++ b/build/docs/CreateAgentTimeOffRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateAlternativeShiftTradeRequest.md b/build/docs/CreateAlternativeShiftTradeRequest.md index 7a80f58c3..e9986cef0 100644 --- a/build/docs/CreateAlternativeShiftTradeRequest.md +++ b/build/docs/CreateAlternativeShiftTradeRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateBenefitAssessmentJobRequest.md b/build/docs/CreateBenefitAssessmentJobRequest.md index 479b6717b..ac5705f48 100644 --- a/build/docs/CreateBenefitAssessmentJobRequest.md +++ b/build/docs/CreateBenefitAssessmentJobRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateBenefitAssessmentRequest.md b/build/docs/CreateBenefitAssessmentRequest.md index d43c473c2..512d2942a 100644 --- a/build/docs/CreateBenefitAssessmentRequest.md +++ b/build/docs/CreateBenefitAssessmentRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateBusinessUnitRequest.md b/build/docs/CreateBusinessUnitRequest.md index db277b3af..93d320916 100644 --- a/build/docs/CreateBusinessUnitRequest.md +++ b/build/docs/CreateBusinessUnitRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateBusinessUnitSettingsRequest.md b/build/docs/CreateBusinessUnitSettingsRequest.md index 09de423cc..201200469 100644 --- a/build/docs/CreateBusinessUnitSettingsRequest.md +++ b/build/docs/CreateBusinessUnitSettingsRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateCallRequest.md b/build/docs/CreateCallRequest.md index 7d996d2c0..6ae17021e 100644 --- a/build/docs/CreateCallRequest.md +++ b/build/docs/CreateCallRequest.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateCallResponse.md b/build/docs/CreateCallResponse.md index 18f7b2324..8f6784351 100644 --- a/build/docs/CreateCallResponse.md +++ b/build/docs/CreateCallResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateCallbackCommand.md b/build/docs/CreateCallbackCommand.md index d5cd6b25e..7ad7f67dc 100644 --- a/build/docs/CreateCallbackCommand.md +++ b/build/docs/CreateCallbackCommand.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateCallbackOnConversationCommand.md b/build/docs/CreateCallbackOnConversationCommand.md index ca01771e3..a992b89e0 100644 --- a/build/docs/CreateCallbackOnConversationCommand.md +++ b/build/docs/CreateCallbackOnConversationCommand.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateCallbackResponse.md b/build/docs/CreateCallbackResponse.md index 6a1f0c6ff..bb0ba7527 100644 --- a/build/docs/CreateCallbackResponse.md +++ b/build/docs/CreateCallbackResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateCoachingAppointmentRequest.md b/build/docs/CreateCoachingAppointmentRequest.md index 1ae02de50..b2aceefb6 100644 --- a/build/docs/CreateCoachingAppointmentRequest.md +++ b/build/docs/CreateCoachingAppointmentRequest.md @@ -20,4 +20,4 @@ Create coaching appointment request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateEmailRequest.md b/build/docs/CreateEmailRequest.md index 2c39420aa..76a04bfb1 100644 --- a/build/docs/CreateEmailRequest.md +++ b/build/docs/CreateEmailRequest.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateGeneralProgramTopicsDefinitionsJob.md b/build/docs/CreateGeneralProgramTopicsDefinitionsJob.md index 453dc97a4..ecfaa7b50 100644 --- a/build/docs/CreateGeneralProgramTopicsDefinitionsJob.md +++ b/build/docs/CreateGeneralProgramTopicsDefinitionsJob.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateIntegrationRequest.md b/build/docs/CreateIntegrationRequest.md index e0104721c..3d72f479a 100644 --- a/build/docs/CreateIntegrationRequest.md +++ b/build/docs/CreateIntegrationRequest.md @@ -14,4 +14,4 @@ Details for an Integration -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateManagementUnitApiRequest.md b/build/docs/CreateManagementUnitApiRequest.md index 1e0df1e89..8ee1720dd 100644 --- a/build/docs/CreateManagementUnitApiRequest.md +++ b/build/docs/CreateManagementUnitApiRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateManagementUnitSettingsRequest.md b/build/docs/CreateManagementUnitSettingsRequest.md index dcb7eb675..b5721fa3f 100644 --- a/build/docs/CreateManagementUnitSettingsRequest.md +++ b/build/docs/CreateManagementUnitSettingsRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateMetric.md b/build/docs/CreateMetric.md index 66e09e1b5..28de52405 100644 --- a/build/docs/CreateMetric.md +++ b/build/docs/CreateMetric.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateObjective.md b/build/docs/CreateObjective.md index f7caeeed1..fc518eeab 100644 --- a/build/docs/CreateObjective.md +++ b/build/docs/CreateObjective.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateOutboundMessagingConversationRequest.md b/build/docs/CreateOutboundMessagingConversationRequest.md index b4789d992..ea229682c 100644 --- a/build/docs/CreateOutboundMessagingConversationRequest.md +++ b/build/docs/CreateOutboundMessagingConversationRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateOutboundMessagingConversationResponse.md b/build/docs/CreateOutboundMessagingConversationResponse.md index 2399b6ea4..f1c0243aa 100644 --- a/build/docs/CreateOutboundMessagingConversationResponse.md +++ b/build/docs/CreateOutboundMessagingConversationResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreatePerformanceProfile.md b/build/docs/CreatePerformanceProfile.md index 48300ec5b..453b17f89 100644 --- a/build/docs/CreatePerformanceProfile.md +++ b/build/docs/CreatePerformanceProfile.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreatePlanningGroupRequest.md b/build/docs/CreatePlanningGroupRequest.md index 4e4c0e729..049131c78 100644 --- a/build/docs/CreatePlanningGroupRequest.md +++ b/build/docs/CreatePlanningGroupRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreatePredictorRequest.md b/build/docs/CreatePredictorRequest.md index 6d8d47298..7cc5857ca 100644 --- a/build/docs/CreatePredictorRequest.md +++ b/build/docs/CreatePredictorRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateQueueRequest.md b/build/docs/CreateQueueRequest.md index 065b3f6c8..0a161219c 100644 --- a/build/docs/CreateQueueRequest.md +++ b/build/docs/CreateQueueRequest.md @@ -49,4 +49,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateRecognition.md b/build/docs/CreateRecognition.md index 3ea3710d9..8bb4cb3d2 100644 --- a/build/docs/CreateRecognition.md +++ b/build/docs/CreateRecognition.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateResponseAssetRequest.md b/build/docs/CreateResponseAssetRequest.md index a1b9b8b8c..311f1a916 100644 --- a/build/docs/CreateResponseAssetRequest.md +++ b/build/docs/CreateResponseAssetRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateResponseAssetResponse.md b/build/docs/CreateResponseAssetResponse.md index df822136a..3839b5e86 100644 --- a/build/docs/CreateResponseAssetResponse.md +++ b/build/docs/CreateResponseAssetResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateRoomRequest.md b/build/docs/CreateRoomRequest.md index 40fca98b2..e0a37bfbc 100644 --- a/build/docs/CreateRoomRequest.md +++ b/build/docs/CreateRoomRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateRoomResponse.md b/build/docs/CreateRoomResponse.md index a0b1c0e68..9f8298c0e 100644 --- a/build/docs/CreateRoomResponse.md +++ b/build/docs/CreateRoomResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateSecureSession.md b/build/docs/CreateSecureSession.md index 3f2d85d1b..9f7144927 100644 --- a/build/docs/CreateSecureSession.md +++ b/build/docs/CreateSecureSession.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateServiceGoalTemplate.md b/build/docs/CreateServiceGoalTemplate.md index fede7782c..fc9ef2ea3 100644 --- a/build/docs/CreateServiceGoalTemplate.md +++ b/build/docs/CreateServiceGoalTemplate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateShareRequest.md b/build/docs/CreateShareRequest.md index 0d5d44813..6bc04107b 100644 --- a/build/docs/CreateShareRequest.md +++ b/build/docs/CreateShareRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateShareRequestMember.md b/build/docs/CreateShareRequestMember.md index 044e2c03d..8fc3a00f4 100644 --- a/build/docs/CreateShareRequestMember.md +++ b/build/docs/CreateShareRequestMember.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateShareResponse.md b/build/docs/CreateShareResponse.md index 043116077..098319ccf 100644 --- a/build/docs/CreateShareResponse.md +++ b/build/docs/CreateShareResponse.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateStaffingGroupRequest.md b/build/docs/CreateStaffingGroupRequest.md index 3530b0400..2f3cfeeed 100644 --- a/build/docs/CreateStaffingGroupRequest.md +++ b/build/docs/CreateStaffingGroupRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateTimeOffLimitRequest.md b/build/docs/CreateTimeOffLimitRequest.md index 3bd2b231d..1b7c77097 100644 --- a/build/docs/CreateTimeOffLimitRequest.md +++ b/build/docs/CreateTimeOffLimitRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateTimeOffPlanBusinessUnitAssociation.md b/build/docs/CreateTimeOffPlanBusinessUnitAssociation.md index f4bbf7f65..cc2cff3f4 100644 --- a/build/docs/CreateTimeOffPlanBusinessUnitAssociation.md +++ b/build/docs/CreateTimeOffPlanBusinessUnitAssociation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateTimeOffPlanManagementUnitAssociation.md b/build/docs/CreateTimeOffPlanManagementUnitAssociation.md index c15b5333a..172573759 100644 --- a/build/docs/CreateTimeOffPlanManagementUnitAssociation.md +++ b/build/docs/CreateTimeOffPlanManagementUnitAssociation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateTimeOffPlanRequest.md b/build/docs/CreateTimeOffPlanRequest.md index 6a6925cf5..e7658e3ea 100644 --- a/build/docs/CreateTimeOffPlanRequest.md +++ b/build/docs/CreateTimeOffPlanRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateTriggerRequest.md b/build/docs/CreateTriggerRequest.md index 8caafe398..6a1c8fa8e 100644 --- a/build/docs/CreateTriggerRequest.md +++ b/build/docs/CreateTriggerRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateUser.md b/build/docs/CreateUser.md index 1d52c05d3..badef95ed 100644 --- a/build/docs/CreateUser.md +++ b/build/docs/CreateUser.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateUtilizationLabelRequest.md b/build/docs/CreateUtilizationLabelRequest.md index f6d9453a5..7bfeb2aa9 100644 --- a/build/docs/CreateUtilizationLabelRequest.md +++ b/build/docs/CreateUtilizationLabelRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateWebChatConversationRequest.md b/build/docs/CreateWebChatConversationRequest.md index ddef94ea5..36f08f8c1 100644 --- a/build/docs/CreateWebChatConversationRequest.md +++ b/build/docs/CreateWebChatConversationRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateWebChatConversationResponse.md b/build/docs/CreateWebChatConversationResponse.md index 80a92be8f..fbae49356 100644 --- a/build/docs/CreateWebChatConversationResponse.md +++ b/build/docs/CreateWebChatConversationResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateWebChatMessageRequest.md b/build/docs/CreateWebChatMessageRequest.md index 7f5d95121..f8412bb8b 100644 --- a/build/docs/CreateWebChatMessageRequest.md +++ b/build/docs/CreateWebChatMessageRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateWebChatRequest.md b/build/docs/CreateWebChatRequest.md index c87552d5a..516cfa3ca 100644 --- a/build/docs/CreateWebChatRequest.md +++ b/build/docs/CreateWebChatRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateWorkPlan.md b/build/docs/CreateWorkPlan.md index 5fdc540ac..4be18d776 100644 --- a/build/docs/CreateWorkPlan.md +++ b/build/docs/CreateWorkPlan.md @@ -37,4 +37,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateWorkPlanActivity.md b/build/docs/CreateWorkPlanActivity.md index 4fd448add..e735167e3 100644 --- a/build/docs/CreateWorkPlanActivity.md +++ b/build/docs/CreateWorkPlanActivity.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateWorkPlanBid.md b/build/docs/CreateWorkPlanBid.md index eaac2f58d..e34792938 100644 --- a/build/docs/CreateWorkPlanBid.md +++ b/build/docs/CreateWorkPlanBid.md @@ -18,4 +18,4 @@ Create work plan bid model -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CreateWorkPlanShift.md b/build/docs/CreateWorkPlanShift.md index a7d29ee25..bcbf2a784 100644 --- a/build/docs/CreateWorkPlanShift.md +++ b/build/docs/CreateWorkPlanShift.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Credential.md b/build/docs/Credential.md index 5adb874c3..9b35b1786 100644 --- a/build/docs/Credential.md +++ b/build/docs/Credential.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CredentialInfo.md b/build/docs/CredentialInfo.md index 034a3d4af..861350af0 100644 --- a/build/docs/CredentialInfo.md +++ b/build/docs/CredentialInfo.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CredentialInfoListing.md b/build/docs/CredentialInfoListing.md index 26e3c777a..5cd07d680 100644 --- a/build/docs/CredentialInfoListing.md +++ b/build/docs/CredentialInfoListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CredentialSpecification.md b/build/docs/CredentialSpecification.md index 9b55addf4..b010e2887 100644 --- a/build/docs/CredentialSpecification.md +++ b/build/docs/CredentialSpecification.md @@ -13,4 +13,4 @@ Specifies the requirements for a credential that can be provided for configuring -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CredentialType.md b/build/docs/CredentialType.md index f280108ba..04f9681bf 100644 --- a/build/docs/CredentialType.md +++ b/build/docs/CredentialType.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CredentialTypeListing.md b/build/docs/CredentialTypeListing.md index 6fb8f1d64..9fb18bc41 100644 --- a/build/docs/CredentialTypeListing.md +++ b/build/docs/CredentialTypeListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Criteria.md b/build/docs/Criteria.md index 1b2014b63..ec8950af1 100644 --- a/build/docs/Criteria.md +++ b/build/docs/Criteria.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CriteriaCategoryInfo.md b/build/docs/CriteriaCategoryInfo.md index 52e9a0021..59bd17650 100644 --- a/build/docs/CriteriaCategoryInfo.md +++ b/build/docs/CriteriaCategoryInfo.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CriteriaGroup.md b/build/docs/CriteriaGroup.md index b73d9480d..9e1e7000b 100644 --- a/build/docs/CriteriaGroup.md +++ b/build/docs/CriteriaGroup.md @@ -14,4 +14,4 @@ A group of logical or a singular criteria used to create a query of executionDat -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CriteriaItem.md b/build/docs/CriteriaItem.md index 03df62bbe..263256dbd 100644 --- a/build/docs/CriteriaItem.md +++ b/build/docs/CriteriaItem.md @@ -13,4 +13,4 @@ A singular criteria used to query executionData. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CriteriaQuery.md b/build/docs/CriteriaQuery.md index 78ac9a712..adc5edae5 100644 --- a/build/docs/CriteriaQuery.md +++ b/build/docs/CriteriaQuery.md @@ -11,4 +11,4 @@ Used to retrieve executionData based upon certain criteria -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformCallMediaPolicy.md b/build/docs/CrossPlatformCallMediaPolicy.md index 9f8ee731a..863b70709 100644 --- a/build/docs/CrossPlatformCallMediaPolicy.md +++ b/build/docs/CrossPlatformCallMediaPolicy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformChatMediaPolicy.md b/build/docs/CrossPlatformChatMediaPolicy.md index 9a1208958..d1334629b 100644 --- a/build/docs/CrossPlatformChatMediaPolicy.md +++ b/build/docs/CrossPlatformChatMediaPolicy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformEmailMediaPolicy.md b/build/docs/CrossPlatformEmailMediaPolicy.md index b3ca8e869..acbad44cd 100644 --- a/build/docs/CrossPlatformEmailMediaPolicy.md +++ b/build/docs/CrossPlatformEmailMediaPolicy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformMediaPolicies.md b/build/docs/CrossPlatformMediaPolicies.md index bb6dbe698..ffa2c6154 100644 --- a/build/docs/CrossPlatformMediaPolicies.md +++ b/build/docs/CrossPlatformMediaPolicies.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformMessageMediaPolicy.md b/build/docs/CrossPlatformMessageMediaPolicy.md index 615efe0a5..0a92e6576 100644 --- a/build/docs/CrossPlatformMessageMediaPolicy.md +++ b/build/docs/CrossPlatformMessageMediaPolicy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformPolicy.md b/build/docs/CrossPlatformPolicy.md index 2749eadf6..e34572d9a 100644 --- a/build/docs/CrossPlatformPolicy.md +++ b/build/docs/CrossPlatformPolicy.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformPolicyActions.md b/build/docs/CrossPlatformPolicyActions.md index 489f93385..d26633250 100644 --- a/build/docs/CrossPlatformPolicyActions.md +++ b/build/docs/CrossPlatformPolicyActions.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformPolicyCreate.md b/build/docs/CrossPlatformPolicyCreate.md index cc4efaff6..33a995035 100644 --- a/build/docs/CrossPlatformPolicyCreate.md +++ b/build/docs/CrossPlatformPolicyCreate.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CrossPlatformPolicyUpdate.md b/build/docs/CrossPlatformPolicyUpdate.md index 05fff0e1f..646d0b0eb 100644 --- a/build/docs/CrossPlatformPolicyUpdate.md +++ b/build/docs/CrossPlatformPolicyUpdate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CsvJobRequest.md b/build/docs/CsvJobRequest.md index c96247630..42ee8391f 100644 --- a/build/docs/CsvJobRequest.md +++ b/build/docs/CsvJobRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CsvJobResponse.md b/build/docs/CsvJobResponse.md index 979dfde98..d55106503 100644 --- a/build/docs/CsvJobResponse.md +++ b/build/docs/CsvJobResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CsvMappingEntry.md b/build/docs/CsvMappingEntry.md index 0c5da2445..30df256d9 100644 --- a/build/docs/CsvMappingEntry.md +++ b/build/docs/CsvMappingEntry.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CsvSettings.md b/build/docs/CsvSettings.md index 6c5af9594..58d163d6b 100644 --- a/build/docs/CsvSettings.md +++ b/build/docs/CsvSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CsvUploadDetailsResponse.md b/build/docs/CsvUploadDetailsResponse.md index f620786e3..57d4079cb 100644 --- a/build/docs/CsvUploadDetailsResponse.md +++ b/build/docs/CsvUploadDetailsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CsvUploadPreviewResponse.md b/build/docs/CsvUploadPreviewResponse.md index 7fa15fa39..3a01c29ff 100644 --- a/build/docs/CsvUploadPreviewResponse.md +++ b/build/docs/CsvUploadPreviewResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CsvUploadRequest.md b/build/docs/CsvUploadRequest.md index 246bac1a3..8bcf31e16 100644 --- a/build/docs/CsvUploadRequest.md +++ b/build/docs/CsvUploadRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CsvUploadResponse.md b/build/docs/CsvUploadResponse.md index 07ea5064b..8f4ee8686 100644 --- a/build/docs/CsvUploadResponse.md +++ b/build/docs/CsvUploadResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CtaButtonStyleProperties.md b/build/docs/CtaButtonStyleProperties.md index b087e6e1d..3fd241cf4 100644 --- a/build/docs/CtaButtonStyleProperties.md +++ b/build/docs/CtaButtonStyleProperties.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CurrentUserScheduleRequestBody.md b/build/docs/CurrentUserScheduleRequestBody.md index 797bc7b67..10cdf6ef4 100644 --- a/build/docs/CurrentUserScheduleRequestBody.md +++ b/build/docs/CurrentUserScheduleRequestBody.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CurrentUserTimeOffIntegrationStatusRequest.md b/build/docs/CurrentUserTimeOffIntegrationStatusRequest.md index dc7684c9a..ff062d4c0 100644 --- a/build/docs/CurrentUserTimeOffIntegrationStatusRequest.md +++ b/build/docs/CurrentUserTimeOffIntegrationStatusRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CursorContactListing.md b/build/docs/CursorContactListing.md index 3b6dc126a..00206552b 100644 --- a/build/docs/CursorContactListing.md +++ b/build/docs/CursorContactListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CursorExternalSourceListing.md b/build/docs/CursorExternalSourceListing.md index 6d1c021ff..f9d017c9c 100644 --- a/build/docs/CursorExternalSourceListing.md +++ b/build/docs/CursorExternalSourceListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CursorNoteListing.md b/build/docs/CursorNoteListing.md index 6d1770792..c8b355798 100644 --- a/build/docs/CursorNoteListing.md +++ b/build/docs/CursorNoteListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CursorOrganizationListing.md b/build/docs/CursorOrganizationListing.md index 76429048d..623f84bfc 100644 --- a/build/docs/CursorOrganizationListing.md +++ b/build/docs/CursorOrganizationListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CursorRelationshipListing.md b/build/docs/CursorRelationshipListing.md index 01266ace8..394dc9963 100644 --- a/build/docs/CursorRelationshipListing.md +++ b/build/docs/CursorRelationshipListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Cursors.md b/build/docs/Cursors.md index 8dea28191..b49dbad9d 100644 --- a/build/docs/Cursors.md +++ b/build/docs/Cursors.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CustomEventAttribute.md b/build/docs/CustomEventAttribute.md index 570202782..ad4275d1b 100644 --- a/build/docs/CustomEventAttribute.md +++ b/build/docs/CustomEventAttribute.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CustomEventAttributeList.md b/build/docs/CustomEventAttributeList.md index 33f57672a..b5c7a24f9 100644 --- a/build/docs/CustomEventAttributeList.md +++ b/build/docs/CustomEventAttributeList.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CustomI18nLabels.md b/build/docs/CustomI18nLabels.md index 8861d674c..d9591415c 100644 --- a/build/docs/CustomI18nLabels.md +++ b/build/docs/CustomI18nLabels.md @@ -12,4 +12,4 @@ The localization settings for homescreen -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CustomProvider.md b/build/docs/CustomProvider.md index 1d6963bd7..8f460cc35 100644 --- a/build/docs/CustomProvider.md +++ b/build/docs/CustomProvider.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CustomerEndDetailEventTopicCustomerEndEvent.md b/build/docs/CustomerEndDetailEventTopicCustomerEndEvent.md index 2f45dca65..67a13c5a2 100644 --- a/build/docs/CustomerEndDetailEventTopicCustomerEndEvent.md +++ b/build/docs/CustomerEndDetailEventTopicCustomerEndEvent.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CustomerInteractionCenter.md b/build/docs/CustomerInteractionCenter.md index ff2262dd4..a8902dd7d 100644 --- a/build/docs/CustomerInteractionCenter.md +++ b/build/docs/CustomerInteractionCenter.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CustomerStartDetailEventTopicCustomerStartEvent.md b/build/docs/CustomerStartDetailEventTopicCustomerStartEvent.md index e8d97f173..255f19e50 100644 --- a/build/docs/CustomerStartDetailEventTopicCustomerStartEvent.md +++ b/build/docs/CustomerStartDetailEventTopicCustomerStartEvent.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/CustomerStartDetailEventTopicJourneyContext.md b/build/docs/CustomerStartDetailEventTopicJourneyContext.md index 4b23c8cdc..7e43aadf1 100644 --- a/build/docs/CustomerStartDetailEventTopicJourneyContext.md +++ b/build/docs/CustomerStartDetailEventTopicJourneyContext.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DID.md b/build/docs/DID.md index a8e9b087e..1f0b7abc1 100644 --- a/build/docs/DID.md +++ b/build/docs/DID.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DIDEntityListing.md b/build/docs/DIDEntityListing.md index 7f110ff72..7cdf1ffea 100644 --- a/build/docs/DIDEntityListing.md +++ b/build/docs/DIDEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DIDNumber.md b/build/docs/DIDNumber.md index f397e8ad1..cce736c72 100644 --- a/build/docs/DIDNumber.md +++ b/build/docs/DIDNumber.md @@ -18,4 +18,4 @@ Represents an unassigned or assigned DID in a DID Pool. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DIDNumberEntityListing.md b/build/docs/DIDNumberEntityListing.md index 61e6f2b35..ba733c044 100644 --- a/build/docs/DIDNumberEntityListing.md +++ b/build/docs/DIDNumberEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DIDPool.md b/build/docs/DIDPool.md index a2a0a7b07..6bd5c1a26 100644 --- a/build/docs/DIDPool.md +++ b/build/docs/DIDPool.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DIDPoolEntityListing.md b/build/docs/DIDPoolEntityListing.md index 3cc484634..08f44635c 100644 --- a/build/docs/DIDPoolEntityListing.md +++ b/build/docs/DIDPoolEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DailyPossibleShift.md b/build/docs/DailyPossibleShift.md index ab7fdefd5..52412a290 100644 --- a/build/docs/DailyPossibleShift.md +++ b/build/docs/DailyPossibleShift.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DashboardConfiguration.md b/build/docs/DashboardConfiguration.md index 6c82b4923..dede422a8 100644 --- a/build/docs/DashboardConfiguration.md +++ b/build/docs/DashboardConfiguration.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DashboardConfigurationBulkRequest.md b/build/docs/DashboardConfigurationBulkRequest.md index 31d2e6282..e977287e5 100644 --- a/build/docs/DashboardConfigurationBulkRequest.md +++ b/build/docs/DashboardConfigurationBulkRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DashboardConfigurationListing.md b/build/docs/DashboardConfigurationListing.md index f8f1e6aaf..a5b4de7d0 100644 --- a/build/docs/DashboardConfigurationListing.md +++ b/build/docs/DashboardConfigurationListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DashboardConfigurationQueryRequest.md b/build/docs/DashboardConfigurationQueryRequest.md index e563421d0..0f8b97e9f 100644 --- a/build/docs/DashboardConfigurationQueryRequest.md +++ b/build/docs/DashboardConfigurationQueryRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DashboardUser.md b/build/docs/DashboardUser.md index 7a9f48cdb..e67c97b38 100644 --- a/build/docs/DashboardUser.md +++ b/build/docs/DashboardUser.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DashboardUserListing.md b/build/docs/DashboardUserListing.md index ffcd575d2..b13910200 100644 --- a/build/docs/DashboardUserListing.md +++ b/build/docs/DashboardUserListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DashboardsSharedWith.md b/build/docs/DashboardsSharedWith.md index f0277e483..91940cc81 100644 --- a/build/docs/DashboardsSharedWith.md +++ b/build/docs/DashboardsSharedWith.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataActionConditionPredicate.md b/build/docs/DataActionConditionPredicate.md index 8f7352bd5..2e1d8a3fe 100644 --- a/build/docs/DataActionConditionPredicate.md +++ b/build/docs/DataActionConditionPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataActionConditionSettings.md b/build/docs/DataActionConditionSettings.md index 10862bba4..7d2c53d19 100644 --- a/build/docs/DataActionConditionSettings.md +++ b/build/docs/DataActionConditionSettings.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataActionContactColumnFieldMapping.md b/build/docs/DataActionContactColumnFieldMapping.md index a3c602409..d1e42460b 100644 --- a/build/docs/DataActionContactColumnFieldMapping.md +++ b/build/docs/DataActionContactColumnFieldMapping.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataAvailabilityResponse.md b/build/docs/DataAvailabilityResponse.md index e5265edf2..c2ad1b584 100644 --- a/build/docs/DataAvailabilityResponse.md +++ b/build/docs/DataAvailabilityResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataExtensionsAPI.md b/build/docs/DataExtensionsAPI.md index 7a9cc231a..d2d23b863 100644 --- a/build/docs/DataExtensionsAPI.md +++ b/build/docs/DataExtensionsAPI.md @@ -152,4 +152,4 @@ This endpoint does not require any parameters. [**SchemaQuantityLimits**](SchemaQuantityLimits) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataPrivacyAPI.md b/build/docs/DataPrivacyAPI.md new file mode 100644 index 000000000..79c1a3d09 --- /dev/null +++ b/build/docs/DataPrivacyAPI.md @@ -0,0 +1,313 @@ +# DataPrivacyAPI + +All URIs are relative to *https://api.mypurecloud.com* + +| Method | Description | +| ------------- | ------------- | +| [**deleteDataprivacyMaskingrule**](DataPrivacyAPI#deleteDataprivacyMaskingrule) | Delete a masking rule. | +| [**getDataprivacyMaskingrule**](DataPrivacyAPI#getDataprivacyMaskingrule) | Fetch details about a masking rule. | +| [**getDataprivacyMaskingrules**](DataPrivacyAPI#getDataprivacyMaskingrules) | Retrieve the list of masking rules. | +| [**patchDataprivacyMaskingrule**](DataPrivacyAPI#patchDataprivacyMaskingrule) | Update information about a masking rule. | +| [**postDataprivacyMaskingrules**](DataPrivacyAPI#postDataprivacyMaskingrules) | Create a new masking rule resource. | +| [**postDataprivacyMaskingrulesValidate**](DataPrivacyAPI#postDataprivacyMaskingrulesValidate) | Validate masking before creating. | +{: class="table-striped"} + + +## deleteDataprivacyMaskingrule + + + +> Void deleteDataprivacyMaskingrule(ruleId) + +Delete a masking rule. + + + +Wraps DELETE /api/v2/dataprivacy/maskingrules/{ruleId} + +Requires ALL permissions: + +* dataprivacy:maskingrule:delete + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let ruleId: String = "" // ruleId + +// Code example +DataPrivacyAPI.deleteDataprivacyMaskingrule(ruleId: ruleId) { (error) in + if let error = error { + dump(error) + } else { + print("DataPrivacyAPI.deleteDataprivacyMaskingrule was successful") + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **ruleId** | **String**| ruleId | | + + +### Return type + +`nil` (empty response body) + + +## getDataprivacyMaskingrule + + + +> [MaskingRule](MaskingRule) getDataprivacyMaskingrule(ruleId) + +Fetch details about a masking rule. + + + +Wraps GET /api/v2/dataprivacy/maskingrules/{ruleId} + +Requires ALL permissions: + +* dataprivacy:maskingrule:view + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let ruleId: String = "" // ruleId + +// Code example +DataPrivacyAPI.getDataprivacyMaskingrule(ruleId: ruleId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DataPrivacyAPI.getDataprivacyMaskingrule was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **ruleId** | **String**| ruleId | | + + +### Return type + +[**MaskingRule**](MaskingRule) + + +## getDataprivacyMaskingrules + + + +> [MaskingRuleListing](MaskingRuleListing) getDataprivacyMaskingrules() + +Retrieve the list of masking rules. + + + +Wraps GET /api/v2/dataprivacy/maskingrules + +Requires ALL permissions: + +* dataprivacy:maskingrule:view + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + + +// Code example +DataPrivacyAPI.getDataprivacyMaskingrules() { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DataPrivacyAPI.getDataprivacyMaskingrules was successful") + dump(response) + } +} +``` + +### Parameters + +This endpoint does not require any parameters. + + +### Return type + +[**MaskingRuleListing**](MaskingRuleListing) + + +## patchDataprivacyMaskingrule + + + +> [MaskingRule](MaskingRule) patchDataprivacyMaskingrule(ruleId, body) + +Update information about a masking rule. + + + +Wraps PATCH /api/v2/dataprivacy/maskingrules/{ruleId} + +Requires ALL permissions: + +* dataprivacy:maskingrule:edit + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let ruleId: String = "" // ruleId +let body: MaskingRule = new MaskingRule(...) // + +// Code example +DataPrivacyAPI.patchDataprivacyMaskingrule(ruleId: ruleId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DataPrivacyAPI.patchDataprivacyMaskingrule was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **ruleId** | **String**| ruleId | | +| **body** | [**MaskingRule**](MaskingRule)| | [optional] | + + +### Return type + +[**MaskingRule**](MaskingRule) + + +## postDataprivacyMaskingrules + + + +> [MaskingRule](MaskingRule) postDataprivacyMaskingrules(body) + +Create a new masking rule resource. + + + +Wraps POST /api/v2/dataprivacy/maskingrules + +Requires ALL permissions: + +* dataprivacy:maskingrule:add + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let body: MaskingRule = new MaskingRule(...) // Details for creating masking rule resource + +// Code example +DataPrivacyAPI.postDataprivacyMaskingrules(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DataPrivacyAPI.postDataprivacyMaskingrules was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **body** | [**MaskingRule**](MaskingRule)| Details for creating masking rule resource | | + + +### Return type + +[**MaskingRule**](MaskingRule) + + +## postDataprivacyMaskingrulesValidate + + + +> [MaskingRuleValidateResponse](MaskingRuleValidateResponse) postDataprivacyMaskingrulesValidate(body) + +Validate masking before creating. + + + +Wraps POST /api/v2/dataprivacy/maskingrules/validate + +Requires ALL permissions: + +* dataprivacy:maskingrule:execute + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let body: MaskingRuleValidateRequest = new MaskingRuleValidateRequest(...) // Text to be masked + +// Code example +DataPrivacyAPI.postDataprivacyMaskingrulesValidate(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("DataPrivacyAPI.postDataprivacyMaskingrulesValidate was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **body** | [**MaskingRuleValidateRequest**](MaskingRuleValidateRequest)| Text to be masked | | + + +### Return type + +[**MaskingRuleValidateResponse**](MaskingRuleValidateResponse) + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataSchema.md b/build/docs/DataSchema.md index c015f7889..1a9dbd443 100644 --- a/build/docs/DataSchema.md +++ b/build/docs/DataSchema.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataSchemaListing.md b/build/docs/DataSchemaListing.md index 1cb6f862f..39113b15d 100644 --- a/build/docs/DataSchemaListing.md +++ b/build/docs/DataSchemaListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataTable.md b/build/docs/DataTable.md index 0e6c28ba8..c6ccaf72e 100644 --- a/build/docs/DataTable.md +++ b/build/docs/DataTable.md @@ -16,4 +16,4 @@ Contains a metadata representation for a JSON schema stored in DataTables along -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataTableExportJob.md b/build/docs/DataTableExportJob.md index d0fbb085b..6fc5e57a7 100644 --- a/build/docs/DataTableExportJob.md +++ b/build/docs/DataTableExportJob.md @@ -20,4 +20,4 @@ State information for an export job of rows from a datatable -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataTableImportEntityListing.md b/build/docs/DataTableImportEntityListing.md index eb5941e8a..c40f44451 100644 --- a/build/docs/DataTableImportEntityListing.md +++ b/build/docs/DataTableImportEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataTableImportJob.md b/build/docs/DataTableImportJob.md index a2f915945..d9ecc89b9 100644 --- a/build/docs/DataTableImportJob.md +++ b/build/docs/DataTableImportJob.md @@ -23,4 +23,4 @@ State information for an import job of rows to a datatable -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataTableRowEntityListing.md b/build/docs/DataTableRowEntityListing.md index aa2c8ddf5..1728dc5f9 100644 --- a/build/docs/DataTableRowEntityListing.md +++ b/build/docs/DataTableRowEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DataTablesDomainEntityListing.md b/build/docs/DataTablesDomainEntityListing.md index afbe054c0..1bc17eaed 100644 --- a/build/docs/DataTablesDomainEntityListing.md +++ b/build/docs/DataTablesDomainEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DateRange.md b/build/docs/DateRange.md index c5bccf56c..8e2061db8 100644 --- a/build/docs/DateRange.md +++ b/build/docs/DateRange.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DateRangeWithOptionalEnd.md b/build/docs/DateRangeWithOptionalEnd.md index d0becd9e6..6b57e1708 100644 --- a/build/docs/DateRangeWithOptionalEnd.md +++ b/build/docs/DateRangeWithOptionalEnd.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DefaultGreetingList.md b/build/docs/DefaultGreetingList.md index 328ea060c..4e582130b 100644 --- a/build/docs/DefaultGreetingList.md +++ b/build/docs/DefaultGreetingList.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DefaultObjective.md b/build/docs/DefaultObjective.md index cabc4c414..11e69f453 100644 --- a/build/docs/DefaultObjective.md +++ b/build/docs/DefaultObjective.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DeletableUserReference.md b/build/docs/DeletableUserReference.md index c1f083aee..633e95fd8 100644 --- a/build/docs/DeletableUserReference.md +++ b/build/docs/DeletableUserReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DeleteProgramResponse.md b/build/docs/DeleteProgramResponse.md index 66d2ed9b6..f428caf11 100644 --- a/build/docs/DeleteProgramResponse.md +++ b/build/docs/DeleteProgramResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DeleteRetention.md b/build/docs/DeleteRetention.md index f04713343..14c298422 100644 --- a/build/docs/DeleteRetention.md +++ b/build/docs/DeleteRetention.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Dependency.md b/build/docs/Dependency.md index be6ab2f8c..12e832277 100644 --- a/build/docs/Dependency.md +++ b/build/docs/Dependency.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DependencyObject.md b/build/docs/DependencyObject.md index cc2cbdc03..6ac52c791 100644 --- a/build/docs/DependencyObject.md +++ b/build/docs/DependencyObject.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DependencyObjectEntityListing.md b/build/docs/DependencyObjectEntityListing.md index 2abb487b2..422e2797a 100644 --- a/build/docs/DependencyObjectEntityListing.md +++ b/build/docs/DependencyObjectEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DependencyStatus.md b/build/docs/DependencyStatus.md index 47777b682..6729d05c0 100644 --- a/build/docs/DependencyStatus.md +++ b/build/docs/DependencyStatus.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DependencyType.md b/build/docs/DependencyType.md index 96b5d5d6a..b656c301a 100644 --- a/build/docs/DependencyType.md +++ b/build/docs/DependencyType.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DependencyTypeEntityListing.md b/build/docs/DependencyTypeEntityListing.md index 10cd7c8ec..41412cbbc 100644 --- a/build/docs/DependencyTypeEntityListing.md +++ b/build/docs/DependencyTypeEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DeploymentPing.md b/build/docs/DeploymentPing.md index 0b7367824..351a4f78c 100644 --- a/build/docs/DeploymentPing.md +++ b/build/docs/DeploymentPing.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DeploymentWebAction.md b/build/docs/DeploymentWebAction.md index f97f00fd3..a310d82bd 100644 --- a/build/docs/DeploymentWebAction.md +++ b/build/docs/DeploymentWebAction.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Destination.md b/build/docs/Destination.md index 67b6cdfa6..23426b775 100644 --- a/build/docs/Destination.md +++ b/build/docs/Destination.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Detail.md b/build/docs/Detail.md index 58259a8c9..1f1d9993b 100644 --- a/build/docs/Detail.md +++ b/build/docs/Detail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DetectedDialogAct.md b/build/docs/DetectedDialogAct.md index ccbfbf422..49af47604 100644 --- a/build/docs/DetectedDialogAct.md +++ b/build/docs/DetectedDialogAct.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DetectedIntent.md b/build/docs/DetectedIntent.md index 86e34f12e..970444b1b 100644 --- a/build/docs/DetectedIntent.md +++ b/build/docs/DetectedIntent.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DetectedNamedEntity.md b/build/docs/DetectedNamedEntity.md index bae5bbca1..10995204b 100644 --- a/build/docs/DetectedNamedEntity.md +++ b/build/docs/DetectedNamedEntity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DetectedNamedEntityValue.md b/build/docs/DetectedNamedEntityValue.md index cd36c9f0c..ac444eb6e 100644 --- a/build/docs/DetectedNamedEntityValue.md +++ b/build/docs/DetectedNamedEntityValue.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivity.md b/build/docs/DevelopmentActivity.md index c88db9149..ad3e3753d 100644 --- a/build/docs/DevelopmentActivity.md +++ b/build/docs/DevelopmentActivity.md @@ -27,4 +27,4 @@ Development Activity object -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateParam.md b/build/docs/DevelopmentActivityAggregateParam.md index a5740e0fd..7da9a698a 100644 --- a/build/docs/DevelopmentActivityAggregateParam.md +++ b/build/docs/DevelopmentActivityAggregateParam.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateQueryRequestClause.md b/build/docs/DevelopmentActivityAggregateQueryRequestClause.md index 902954e44..75726f75f 100644 --- a/build/docs/DevelopmentActivityAggregateQueryRequestClause.md +++ b/build/docs/DevelopmentActivityAggregateQueryRequestClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateQueryRequestFilter.md b/build/docs/DevelopmentActivityAggregateQueryRequestFilter.md index 269584bbe..603d74f61 100644 --- a/build/docs/DevelopmentActivityAggregateQueryRequestFilter.md +++ b/build/docs/DevelopmentActivityAggregateQueryRequestFilter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateQueryRequestPredicate.md b/build/docs/DevelopmentActivityAggregateQueryRequestPredicate.md index 295454b8d..c1901db4d 100644 --- a/build/docs/DevelopmentActivityAggregateQueryRequestPredicate.md +++ b/build/docs/DevelopmentActivityAggregateQueryRequestPredicate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateQueryResponseData.md b/build/docs/DevelopmentActivityAggregateQueryResponseData.md index 260090cdc..b1f2657ee 100644 --- a/build/docs/DevelopmentActivityAggregateQueryResponseData.md +++ b/build/docs/DevelopmentActivityAggregateQueryResponseData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateQueryResponseGroupedData.md b/build/docs/DevelopmentActivityAggregateQueryResponseGroupedData.md index 1caad0f30..99fda544c 100644 --- a/build/docs/DevelopmentActivityAggregateQueryResponseGroupedData.md +++ b/build/docs/DevelopmentActivityAggregateQueryResponseGroupedData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateQueryResponseMetric.md b/build/docs/DevelopmentActivityAggregateQueryResponseMetric.md index f5f0b5306..b25082dc2 100644 --- a/build/docs/DevelopmentActivityAggregateQueryResponseMetric.md +++ b/build/docs/DevelopmentActivityAggregateQueryResponseMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateQueryResponseStatistics.md b/build/docs/DevelopmentActivityAggregateQueryResponseStatistics.md index 2557553a5..3e3dc234d 100644 --- a/build/docs/DevelopmentActivityAggregateQueryResponseStatistics.md +++ b/build/docs/DevelopmentActivityAggregateQueryResponseStatistics.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityAggregateResponse.md b/build/docs/DevelopmentActivityAggregateResponse.md index 6613313d6..50ae791d2 100644 --- a/build/docs/DevelopmentActivityAggregateResponse.md +++ b/build/docs/DevelopmentActivityAggregateResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DevelopmentActivityListing.md b/build/docs/DevelopmentActivityListing.md index f3e9c4f33..060b91aa5 100644 --- a/build/docs/DevelopmentActivityListing.md +++ b/build/docs/DevelopmentActivityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Device.md b/build/docs/Device.md index 27039f761..bfbfa5569 100644 --- a/build/docs/Device.md +++ b/build/docs/Device.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerAction.md b/build/docs/DialerAction.md index 02f280951..d1df4f3ba 100644 --- a/build/docs/DialerAction.md +++ b/build/docs/DialerAction.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerAttemptLimitsConfigChangeAttemptLimits.md b/build/docs/DialerAttemptLimitsConfigChangeAttemptLimits.md index d0722d14f..99d31ba48 100644 --- a/build/docs/DialerAttemptLimitsConfigChangeAttemptLimits.md +++ b/build/docs/DialerAttemptLimitsConfigChangeAttemptLimits.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerAttemptLimitsConfigChangeObject.md b/build/docs/DialerAttemptLimitsConfigChangeObject.md index 3f1a0c123..793ef6587 100644 --- a/build/docs/DialerAttemptLimitsConfigChangeObject.md +++ b/build/docs/DialerAttemptLimitsConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerAttemptLimitsConfigChangeRecallEntry.md b/build/docs/DialerAttemptLimitsConfigChangeRecallEntry.md index ebb0c37dd..b2223c27d 100644 --- a/build/docs/DialerAttemptLimitsConfigChangeRecallEntry.md +++ b/build/docs/DialerAttemptLimitsConfigChangeRecallEntry.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCallabletimesetConfigChangeCallableTime.md b/build/docs/DialerCallabletimesetConfigChangeCallableTime.md index b05d91cf1..ea51cb6a9 100644 --- a/build/docs/DialerCallabletimesetConfigChangeCallableTime.md +++ b/build/docs/DialerCallabletimesetConfigChangeCallableTime.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCallabletimesetConfigChangeCallableTimeSet.md b/build/docs/DialerCallabletimesetConfigChangeCallableTimeSet.md index 90709cf7a..41eda297a 100644 --- a/build/docs/DialerCallabletimesetConfigChangeCallableTimeSet.md +++ b/build/docs/DialerCallabletimesetConfigChangeCallableTimeSet.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCallabletimesetConfigChangeObject.md b/build/docs/DialerCallabletimesetConfigChangeObject.md index d9f7d34d7..39afbe708 100644 --- a/build/docs/DialerCallabletimesetConfigChangeObject.md +++ b/build/docs/DialerCallabletimesetConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCallabletimesetConfigChangeTimeSlot.md b/build/docs/DialerCallabletimesetConfigChangeTimeSlot.md index 9a58bde6c..ef1f83e2e 100644 --- a/build/docs/DialerCallabletimesetConfigChangeTimeSlot.md +++ b/build/docs/DialerCallabletimesetConfigChangeTimeSlot.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignConfigChangeCampaign.md b/build/docs/DialerCampaignConfigChangeCampaign.md index 8e94bc71b..fa9638261 100644 --- a/build/docs/DialerCampaignConfigChangeCampaign.md +++ b/build/docs/DialerCampaignConfigChangeCampaign.md @@ -43,4 +43,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignConfigChangeContactSort.md b/build/docs/DialerCampaignConfigChangeContactSort.md index f40979c8f..40e584d66 100644 --- a/build/docs/DialerCampaignConfigChangeContactSort.md +++ b/build/docs/DialerCampaignConfigChangeContactSort.md @@ -14,4 +14,4 @@ information determining the order in which the contacts will be dialed -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignConfigChangeObject.md b/build/docs/DialerCampaignConfigChangeObject.md index 639a90987..a0dc2e7b9 100644 --- a/build/docs/DialerCampaignConfigChangeObject.md +++ b/build/docs/DialerCampaignConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignConfigChangePhoneColumn.md b/build/docs/DialerCampaignConfigChangePhoneColumn.md index 22590d881..35a5593ec 100644 --- a/build/docs/DialerCampaignConfigChangePhoneColumn.md +++ b/build/docs/DialerCampaignConfigChangePhoneColumn.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignConfigChangeRestErrorDetail.md b/build/docs/DialerCampaignConfigChangeRestErrorDetail.md index c68510bdc..36a7201d3 100644 --- a/build/docs/DialerCampaignConfigChangeRestErrorDetail.md +++ b/build/docs/DialerCampaignConfigChangeRestErrorDetail.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignConfigChangeUriReference.md b/build/docs/DialerCampaignConfigChangeUriReference.md index be161632e..cd463b299 100644 --- a/build/docs/DialerCampaignConfigChangeUriReference.md +++ b/build/docs/DialerCampaignConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignProgressEventCampaignProgress.md b/build/docs/DialerCampaignProgressEventCampaignProgress.md index d1dced861..dee455772 100644 --- a/build/docs/DialerCampaignProgressEventCampaignProgress.md +++ b/build/docs/DialerCampaignProgressEventCampaignProgress.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignProgressEventObject.md b/build/docs/DialerCampaignProgressEventObject.md index 2dab0d4a5..41c5d9da8 100644 --- a/build/docs/DialerCampaignProgressEventObject.md +++ b/build/docs/DialerCampaignProgressEventObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignProgressEventUriReference.md b/build/docs/DialerCampaignProgressEventUriReference.md index 9ca146b86..e9135b9a3 100644 --- a/build/docs/DialerCampaignProgressEventUriReference.md +++ b/build/docs/DialerCampaignProgressEventUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignRuleConfigChangeCampaignRule.md b/build/docs/DialerCampaignRuleConfigChangeCampaignRule.md index aff91d69d..c0d6adeef 100644 --- a/build/docs/DialerCampaignRuleConfigChangeCampaignRule.md +++ b/build/docs/DialerCampaignRuleConfigChangeCampaignRule.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignRuleConfigChangeCampaignRuleAction.md b/build/docs/DialerCampaignRuleConfigChangeCampaignRuleAction.md index 8f9ec4933..05bc84989 100644 --- a/build/docs/DialerCampaignRuleConfigChangeCampaignRuleAction.md +++ b/build/docs/DialerCampaignRuleConfigChangeCampaignRuleAction.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignRuleConfigChangeCampaignRuleActionEntities.md b/build/docs/DialerCampaignRuleConfigChangeCampaignRuleActionEntities.md index 6484c219a..4519e263f 100644 --- a/build/docs/DialerCampaignRuleConfigChangeCampaignRuleActionEntities.md +++ b/build/docs/DialerCampaignRuleConfigChangeCampaignRuleActionEntities.md @@ -14,4 +14,4 @@ the campaign/sequence entities that this action acts on -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignRuleConfigChangeCampaignRuleCondition.md b/build/docs/DialerCampaignRuleConfigChangeCampaignRuleCondition.md index 33a5b57d5..612993456 100644 --- a/build/docs/DialerCampaignRuleConfigChangeCampaignRuleCondition.md +++ b/build/docs/DialerCampaignRuleConfigChangeCampaignRuleCondition.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignRuleConfigChangeCampaignRuleEntities.md b/build/docs/DialerCampaignRuleConfigChangeCampaignRuleEntities.md index 82d8739a5..15d737a1b 100644 --- a/build/docs/DialerCampaignRuleConfigChangeCampaignRuleEntities.md +++ b/build/docs/DialerCampaignRuleConfigChangeCampaignRuleEntities.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignRuleConfigChangeObject.md b/build/docs/DialerCampaignRuleConfigChangeObject.md index 1339c8fa4..6d132ac8b 100644 --- a/build/docs/DialerCampaignRuleConfigChangeObject.md +++ b/build/docs/DialerCampaignRuleConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignRuleConfigChangeUriReference.md b/build/docs/DialerCampaignRuleConfigChangeUriReference.md index c44bc9007..6491b52d8 100644 --- a/build/docs/DialerCampaignRuleConfigChangeUriReference.md +++ b/build/docs/DialerCampaignRuleConfigChangeUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignScheduleConfigChangeAlteration.md b/build/docs/DialerCampaignScheduleConfigChangeAlteration.md index dec0be8e7..5f7877945 100644 --- a/build/docs/DialerCampaignScheduleConfigChangeAlteration.md +++ b/build/docs/DialerCampaignScheduleConfigChangeAlteration.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignScheduleConfigChangeCampaignSchedule.md b/build/docs/DialerCampaignScheduleConfigChangeCampaignSchedule.md index 11f045712..5fdf9156a 100644 --- a/build/docs/DialerCampaignScheduleConfigChangeCampaignSchedule.md +++ b/build/docs/DialerCampaignScheduleConfigChangeCampaignSchedule.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignScheduleConfigChangeObject.md b/build/docs/DialerCampaignScheduleConfigChangeObject.md index 8f4caf28e..34afb48a5 100644 --- a/build/docs/DialerCampaignScheduleConfigChangeObject.md +++ b/build/docs/DialerCampaignScheduleConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignScheduleConfigChangeRecurrencePattern.md b/build/docs/DialerCampaignScheduleConfigChangeRecurrencePattern.md index c9f906915..5309f061e 100644 --- a/build/docs/DialerCampaignScheduleConfigChangeRecurrencePattern.md +++ b/build/docs/DialerCampaignScheduleConfigChangeRecurrencePattern.md @@ -14,4 +14,4 @@ the schedule pattern -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignScheduleConfigChangeRecurrenceRange.md b/build/docs/DialerCampaignScheduleConfigChangeRecurrenceRange.md index bce691245..96bc6160d 100644 --- a/build/docs/DialerCampaignScheduleConfigChangeRecurrenceRange.md +++ b/build/docs/DialerCampaignScheduleConfigChangeRecurrenceRange.md @@ -14,4 +14,4 @@ the schedule range -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignScheduleConfigChangeScheduleInterval.md b/build/docs/DialerCampaignScheduleConfigChangeScheduleInterval.md index 24bc1ecdd..e52657168 100644 --- a/build/docs/DialerCampaignScheduleConfigChangeScheduleInterval.md +++ b/build/docs/DialerCampaignScheduleConfigChangeScheduleInterval.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignScheduleConfigChangeScheduleRecurrence.md b/build/docs/DialerCampaignScheduleConfigChangeScheduleRecurrence.md index 80b959547..b7621a8b6 100644 --- a/build/docs/DialerCampaignScheduleConfigChangeScheduleRecurrence.md +++ b/build/docs/DialerCampaignScheduleConfigChangeScheduleRecurrence.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerCampaignScheduleConfigChangeUriReference.md b/build/docs/DialerCampaignScheduleConfigChangeUriReference.md index 57f28206b..69f6e512e 100644 --- a/build/docs/DialerCampaignScheduleConfigChangeUriReference.md +++ b/build/docs/DialerCampaignScheduleConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContact.md b/build/docs/DialerContact.md index 3b1b5e432..5153a238e 100644 --- a/build/docs/DialerContact.md +++ b/build/docs/DialerContact.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactId.md b/build/docs/DialerContactId.md index cefab48e6..9e1d82cd0 100644 --- a/build/docs/DialerContactId.md +++ b/build/docs/DialerContactId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistConfigChangeContactList.md b/build/docs/DialerContactlistConfigChangeContactList.md index 0b5fd542d..5065a28fd 100644 --- a/build/docs/DialerContactlistConfigChangeContactList.md +++ b/build/docs/DialerContactlistConfigChangeContactList.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistConfigChangeContactPhoneNumberColumn.md b/build/docs/DialerContactlistConfigChangeContactPhoneNumberColumn.md index f2a93d0e0..61d5e6ddb 100644 --- a/build/docs/DialerContactlistConfigChangeContactPhoneNumberColumn.md +++ b/build/docs/DialerContactlistConfigChangeContactPhoneNumberColumn.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistConfigChangeEmailColumn.md b/build/docs/DialerContactlistConfigChangeEmailColumn.md index 9f06f2e68..c7a047ebd 100644 --- a/build/docs/DialerContactlistConfigChangeEmailColumn.md +++ b/build/docs/DialerContactlistConfigChangeEmailColumn.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistConfigChangeImportStatus.md b/build/docs/DialerContactlistConfigChangeImportStatus.md index b4065fe3d..ca07d2b8b 100644 --- a/build/docs/DialerContactlistConfigChangeImportStatus.md +++ b/build/docs/DialerContactlistConfigChangeImportStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistConfigChangeObject.md b/build/docs/DialerContactlistConfigChangeObject.md index 0a3352548..c7ca31a4d 100644 --- a/build/docs/DialerContactlistConfigChangeObject.md +++ b/build/docs/DialerContactlistConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistConfigChangeUriReference.md b/build/docs/DialerContactlistConfigChangeUriReference.md index 4ef52c741..702d47a37 100644 --- a/build/docs/DialerContactlistConfigChangeUriReference.md +++ b/build/docs/DialerContactlistConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistfilterConfigChangeContactListFilter.md b/build/docs/DialerContactlistfilterConfigChangeContactListFilter.md index d88755afd..0a6fac48c 100644 --- a/build/docs/DialerContactlistfilterConfigChangeContactListFilter.md +++ b/build/docs/DialerContactlistfilterConfigChangeContactListFilter.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistfilterConfigChangeFilterClause.md b/build/docs/DialerContactlistfilterConfigChangeFilterClause.md index b17cc05a3..4a037772e 100644 --- a/build/docs/DialerContactlistfilterConfigChangeFilterClause.md +++ b/build/docs/DialerContactlistfilterConfigChangeFilterClause.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistfilterConfigChangeFilterPredicate.md b/build/docs/DialerContactlistfilterConfigChangeFilterPredicate.md index 1807caafc..cd01c2ad5 100644 --- a/build/docs/DialerContactlistfilterConfigChangeFilterPredicate.md +++ b/build/docs/DialerContactlistfilterConfigChangeFilterPredicate.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistfilterConfigChangeObject.md b/build/docs/DialerContactlistfilterConfigChangeObject.md index 61bf96203..26c7e1f5f 100644 --- a/build/docs/DialerContactlistfilterConfigChangeObject.md +++ b/build/docs/DialerContactlistfilterConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistfilterConfigChangeRange.md b/build/docs/DialerContactlistfilterConfigChangeRange.md index de736884e..6b3574941 100644 --- a/build/docs/DialerContactlistfilterConfigChangeRange.md +++ b/build/docs/DialerContactlistfilterConfigChangeRange.md @@ -16,4 +16,4 @@ FilterRange is one of the attributes of a FilterPredicate -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerContactlistfilterConfigChangeUriReference.md b/build/docs/DialerContactlistfilterConfigChangeUriReference.md index a2a4144c6..0d74c194f 100644 --- a/build/docs/DialerContactlistfilterConfigChangeUriReference.md +++ b/build/docs/DialerContactlistfilterConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerDnclistConfigChangeDncList.md b/build/docs/DialerDnclistConfigChangeDncList.md index 95dd2e296..f74c953eb 100644 --- a/build/docs/DialerDnclistConfigChangeDncList.md +++ b/build/docs/DialerDnclistConfigChangeDncList.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerDnclistConfigChangeImportStatus.md b/build/docs/DialerDnclistConfigChangeImportStatus.md index 1fc422065..39f94b143 100644 --- a/build/docs/DialerDnclistConfigChangeImportStatus.md +++ b/build/docs/DialerDnclistConfigChangeImportStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerDnclistConfigChangeObject.md b/build/docs/DialerDnclistConfigChangeObject.md index 69654c35e..9190f638d 100644 --- a/build/docs/DialerDnclistConfigChangeObject.md +++ b/build/docs/DialerDnclistConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerDnclistConfigChangeUriReference.md b/build/docs/DialerDnclistConfigChangeUriReference.md index db825d134..7971feeec 100644 --- a/build/docs/DialerDnclistConfigChangeUriReference.md +++ b/build/docs/DialerDnclistConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerEventEntityListing.md b/build/docs/DialerEventEntityListing.md index d1c26a99e..634baf154 100644 --- a/build/docs/DialerEventEntityListing.md +++ b/build/docs/DialerEventEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerOutboundSettingsConfigChangeAtzmTimeSlot.md b/build/docs/DialerOutboundSettingsConfigChangeAtzmTimeSlot.md index 25e5efb37..219e62170 100644 --- a/build/docs/DialerOutboundSettingsConfigChangeAtzmTimeSlot.md +++ b/build/docs/DialerOutboundSettingsConfigChangeAtzmTimeSlot.md @@ -12,4 +12,4 @@ The time interval to place outbound calls -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerOutboundSettingsConfigChangeAtzmTimeSlotWithTimeZone.md b/build/docs/DialerOutboundSettingsConfigChangeAtzmTimeSlotWithTimeZone.md index f2ab10ffd..87ec0314c 100644 --- a/build/docs/DialerOutboundSettingsConfigChangeAtzmTimeSlotWithTimeZone.md +++ b/build/docs/DialerOutboundSettingsConfigChangeAtzmTimeSlotWithTimeZone.md @@ -13,4 +13,4 @@ The time interval to place outbound calls -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerOutboundSettingsConfigChangeAutomaticTimeZoneMappingSettings.md b/build/docs/DialerOutboundSettingsConfigChangeAutomaticTimeZoneMappingSettings.md index 408263878..0cd30779c 100644 --- a/build/docs/DialerOutboundSettingsConfigChangeAutomaticTimeZoneMappingSettings.md +++ b/build/docs/DialerOutboundSettingsConfigChangeAutomaticTimeZoneMappingSettings.md @@ -11,4 +11,4 @@ The settings for automatic time zone mapping -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerOutboundSettingsConfigChangeCallableWindow.md b/build/docs/DialerOutboundSettingsConfigChangeCallableWindow.md index 813e34776..55821c863 100644 --- a/build/docs/DialerOutboundSettingsConfigChangeCallableWindow.md +++ b/build/docs/DialerOutboundSettingsConfigChangeCallableWindow.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerOutboundSettingsConfigChangeOutboundSettings.md b/build/docs/DialerOutboundSettingsConfigChangeOutboundSettings.md index 7467bef95..3d7e8fad7 100644 --- a/build/docs/DialerOutboundSettingsConfigChangeOutboundSettings.md +++ b/build/docs/DialerOutboundSettingsConfigChangeOutboundSettings.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerPreview.md b/build/docs/DialerPreview.md index 4561db5ff..1eba1797e 100644 --- a/build/docs/DialerPreview.md +++ b/build/docs/DialerPreview.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerResponsesetConfigChangeObject.md b/build/docs/DialerResponsesetConfigChangeObject.md index 78be115c9..dddd25fb1 100644 --- a/build/docs/DialerResponsesetConfigChangeObject.md +++ b/build/docs/DialerResponsesetConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerResponsesetConfigChangeReaction.md b/build/docs/DialerResponsesetConfigChangeReaction.md index c40429347..84e418730 100644 --- a/build/docs/DialerResponsesetConfigChangeReaction.md +++ b/build/docs/DialerResponsesetConfigChangeReaction.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerResponsesetConfigChangeResponseSet.md b/build/docs/DialerResponsesetConfigChangeResponseSet.md index 1435a69d5..6a1492648 100644 --- a/build/docs/DialerResponsesetConfigChangeResponseSet.md +++ b/build/docs/DialerResponsesetConfigChangeResponseSet.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRule.md b/build/docs/DialerRule.md index 2b8291e75..17781b151 100644 --- a/build/docs/DialerRule.md +++ b/build/docs/DialerRule.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRulesetConfigChangeAction.md b/build/docs/DialerRulesetConfigChangeAction.md index 1279c0f79..af0215d4a 100644 --- a/build/docs/DialerRulesetConfigChangeAction.md +++ b/build/docs/DialerRulesetConfigChangeAction.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRulesetConfigChangeCondition.md b/build/docs/DialerRulesetConfigChangeCondition.md index c44463b9b..9ed01fd72 100644 --- a/build/docs/DialerRulesetConfigChangeCondition.md +++ b/build/docs/DialerRulesetConfigChangeCondition.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRulesetConfigChangeContactColumnToDataActionFieldMapping.md b/build/docs/DialerRulesetConfigChangeContactColumnToDataActionFieldMapping.md index f9b6a7b8c..1ec6eb54f 100644 --- a/build/docs/DialerRulesetConfigChangeContactColumnToDataActionFieldMapping.md +++ b/build/docs/DialerRulesetConfigChangeContactColumnToDataActionFieldMapping.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md b/build/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md index 8792d1992..feb982c4b 100644 --- a/build/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md +++ b/build/docs/DialerRulesetConfigChangeDataActionConditionPredicate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRulesetConfigChangeObject.md b/build/docs/DialerRulesetConfigChangeObject.md index 9d7738e02..a0ddb1b92 100644 --- a/build/docs/DialerRulesetConfigChangeObject.md +++ b/build/docs/DialerRulesetConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRulesetConfigChangeRule.md b/build/docs/DialerRulesetConfigChangeRule.md index 803a9bd78..bec2ee7b5 100644 --- a/build/docs/DialerRulesetConfigChangeRule.md +++ b/build/docs/DialerRulesetConfigChangeRule.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRulesetConfigChangeRuleSet.md b/build/docs/DialerRulesetConfigChangeRuleSet.md index ab69694b8..48291ded7 100644 --- a/build/docs/DialerRulesetConfigChangeRuleSet.md +++ b/build/docs/DialerRulesetConfigChangeRuleSet.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerRulesetConfigChangeUriReference.md b/build/docs/DialerRulesetConfigChangeUriReference.md index 3859e2d7f..d60bde5e2 100644 --- a/build/docs/DialerRulesetConfigChangeUriReference.md +++ b/build/docs/DialerRulesetConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceConfigChangeCampaignSequence.md b/build/docs/DialerSequenceConfigChangeCampaignSequence.md index ebd101600..a33ec5005 100644 --- a/build/docs/DialerSequenceConfigChangeCampaignSequence.md +++ b/build/docs/DialerSequenceConfigChangeCampaignSequence.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceConfigChangeObject.md b/build/docs/DialerSequenceConfigChangeObject.md index cb26245ea..0605331c6 100644 --- a/build/docs/DialerSequenceConfigChangeObject.md +++ b/build/docs/DialerSequenceConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceConfigChangeUriReference.md b/build/docs/DialerSequenceConfigChangeUriReference.md index 6f24a4622..5a1b5d905 100644 --- a/build/docs/DialerSequenceConfigChangeUriReference.md +++ b/build/docs/DialerSequenceConfigChangeUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceScheduleConfigChangeAlteration.md b/build/docs/DialerSequenceScheduleConfigChangeAlteration.md index 403592af7..661be609f 100644 --- a/build/docs/DialerSequenceScheduleConfigChangeAlteration.md +++ b/build/docs/DialerSequenceScheduleConfigChangeAlteration.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceScheduleConfigChangeObject.md b/build/docs/DialerSequenceScheduleConfigChangeObject.md index 62bb284c4..34815c563 100644 --- a/build/docs/DialerSequenceScheduleConfigChangeObject.md +++ b/build/docs/DialerSequenceScheduleConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceScheduleConfigChangeRecurrencePattern.md b/build/docs/DialerSequenceScheduleConfigChangeRecurrencePattern.md index 9e654f3bb..1476869cd 100644 --- a/build/docs/DialerSequenceScheduleConfigChangeRecurrencePattern.md +++ b/build/docs/DialerSequenceScheduleConfigChangeRecurrencePattern.md @@ -14,4 +14,4 @@ the schedule pattern -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceScheduleConfigChangeRecurrenceRange.md b/build/docs/DialerSequenceScheduleConfigChangeRecurrenceRange.md index 0a836e5f3..a1cca012c 100644 --- a/build/docs/DialerSequenceScheduleConfigChangeRecurrenceRange.md +++ b/build/docs/DialerSequenceScheduleConfigChangeRecurrenceRange.md @@ -14,4 +14,4 @@ the schedule range -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceScheduleConfigChangeScheduleInterval.md b/build/docs/DialerSequenceScheduleConfigChangeScheduleInterval.md index 5494760d0..0927e17ef 100644 --- a/build/docs/DialerSequenceScheduleConfigChangeScheduleInterval.md +++ b/build/docs/DialerSequenceScheduleConfigChangeScheduleInterval.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceScheduleConfigChangeScheduleRecurrence.md b/build/docs/DialerSequenceScheduleConfigChangeScheduleRecurrence.md index e8cc09839..486a2e9b8 100644 --- a/build/docs/DialerSequenceScheduleConfigChangeScheduleRecurrence.md +++ b/build/docs/DialerSequenceScheduleConfigChangeScheduleRecurrence.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceScheduleConfigChangeSequenceSchedule.md b/build/docs/DialerSequenceScheduleConfigChangeSequenceSchedule.md index c48a16976..ef199eaa4 100644 --- a/build/docs/DialerSequenceScheduleConfigChangeSequenceSchedule.md +++ b/build/docs/DialerSequenceScheduleConfigChangeSequenceSchedule.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerSequenceScheduleConfigChangeUriReference.md b/build/docs/DialerSequenceScheduleConfigChangeUriReference.md index 7ee748291..78da63e1f 100644 --- a/build/docs/DialerSequenceScheduleConfigChangeUriReference.md +++ b/build/docs/DialerSequenceScheduleConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialerWrapupcodemappingConfigChangeWrapUpCodeMapping.md b/build/docs/DialerWrapupcodemappingConfigChangeWrapUpCodeMapping.md index 2690422db..7e5deb8bd 100644 --- a/build/docs/DialerWrapupcodemappingConfigChangeWrapUpCodeMapping.md +++ b/build/docs/DialerWrapupcodemappingConfigChangeWrapUpCodeMapping.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowAgent.md b/build/docs/DialogflowAgent.md index 9156eb8a0..e18ab5846 100644 --- a/build/docs/DialogflowAgent.md +++ b/build/docs/DialogflowAgent.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowAgentSummary.md b/build/docs/DialogflowAgentSummary.md index 878f2e462..12f953206 100644 --- a/build/docs/DialogflowAgentSummary.md +++ b/build/docs/DialogflowAgentSummary.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowAgentSummaryEntityListing.md b/build/docs/DialogflowAgentSummaryEntityListing.md index ee3ea4766..24f92ee43 100644 --- a/build/docs/DialogflowAgentSummaryEntityListing.md +++ b/build/docs/DialogflowAgentSummaryEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowCXAgent.md b/build/docs/DialogflowCXAgent.md index 15a618e88..631f38bfe 100644 --- a/build/docs/DialogflowCXAgent.md +++ b/build/docs/DialogflowCXAgent.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowCXAgentSummary.md b/build/docs/DialogflowCXAgentSummary.md index 45cfd17ca..d3c5e447b 100644 --- a/build/docs/DialogflowCXAgentSummary.md +++ b/build/docs/DialogflowCXAgentSummary.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowCXAgentSummaryEntityListing.md b/build/docs/DialogflowCXAgentSummaryEntityListing.md index e234fa747..057a37d08 100644 --- a/build/docs/DialogflowCXAgentSummaryEntityListing.md +++ b/build/docs/DialogflowCXAgentSummaryEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowCXEnvironment.md b/build/docs/DialogflowCXEnvironment.md index 0f5e36545..2f7df0aef 100644 --- a/build/docs/DialogflowCXEnvironment.md +++ b/build/docs/DialogflowCXEnvironment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowCXProject.md b/build/docs/DialogflowCXProject.md index b4f2fcb52..cdc4ba7af 100644 --- a/build/docs/DialogflowCXProject.md +++ b/build/docs/DialogflowCXProject.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowIntent.md b/build/docs/DialogflowIntent.md index 031fb4713..1186aebbb 100644 --- a/build/docs/DialogflowIntent.md +++ b/build/docs/DialogflowIntent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowParameter.md b/build/docs/DialogflowParameter.md index 90f2a2845..11d6c184c 100644 --- a/build/docs/DialogflowParameter.md +++ b/build/docs/DialogflowParameter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DialogflowProject.md b/build/docs/DialogflowProject.md index 804dbfbca..1b34e6753 100644 --- a/build/docs/DialogflowProject.md +++ b/build/docs/DialogflowProject.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DictionaryFeedback.md b/build/docs/DictionaryFeedback.md index e4ffcdf18..837a9bf0f 100644 --- a/build/docs/DictionaryFeedback.md +++ b/build/docs/DictionaryFeedback.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DictionaryFeedbackEntityListing.md b/build/docs/DictionaryFeedbackEntityListing.md index 22c53a12a..db17717f4 100644 --- a/build/docs/DictionaryFeedbackEntityListing.md +++ b/build/docs/DictionaryFeedbackEntityListing.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DictionaryFeedbackExamplePhrase.md b/build/docs/DictionaryFeedbackExamplePhrase.md index 1399477e5..ca6447e18 100644 --- a/build/docs/DictionaryFeedbackExamplePhrase.md +++ b/build/docs/DictionaryFeedbackExamplePhrase.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DigitLength.md b/build/docs/DigitLength.md index fd9e8b6d5..141a27c59 100644 --- a/build/docs/DigitLength.md +++ b/build/docs/DigitLength.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DigitalAction.md b/build/docs/DigitalAction.md index f287c94d3..58490be3b 100644 --- a/build/docs/DigitalAction.md +++ b/build/docs/DigitalAction.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DigitalCondition.md b/build/docs/DigitalCondition.md index cfcbfac47..8169c2b67 100644 --- a/build/docs/DigitalCondition.md +++ b/build/docs/DigitalCondition.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DigitalDataActionConditionPredicate.md b/build/docs/DigitalDataActionConditionPredicate.md index 3200b033a..14f3fb255 100644 --- a/build/docs/DigitalDataActionConditionPredicate.md +++ b/build/docs/DigitalDataActionConditionPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DigitalRule.md b/build/docs/DigitalRule.md index d36a21abc..db5612ef9 100644 --- a/build/docs/DigitalRule.md +++ b/build/docs/DigitalRule.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DigitalRuleSet.md b/build/docs/DigitalRuleSet.md index 94488c0de..2655426d5 100644 --- a/build/docs/DigitalRuleSet.md +++ b/build/docs/DigitalRuleSet.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DigitalRuleSetEntityListing.md b/build/docs/DigitalRuleSetEntityListing.md index d545e79a0..61e2539fc 100644 --- a/build/docs/DigitalRuleSetEntityListing.md +++ b/build/docs/DigitalRuleSetEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Digits.md b/build/docs/Digits.md index 10002b8c2..26fb8de81 100644 --- a/build/docs/Digits.md +++ b/build/docs/Digits.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DirectRouting.md b/build/docs/DirectRouting.md index 67ab4eaf1..ee0c5a31d 100644 --- a/build/docs/DirectRouting.md +++ b/build/docs/DirectRouting.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DirectRoutingMediaSettings.md b/build/docs/DirectRoutingMediaSettings.md index 8e64704f5..165593d3d 100644 --- a/build/docs/DirectRoutingMediaSettings.md +++ b/build/docs/DirectRoutingMediaSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DirectoryUserDevicesListing.md b/build/docs/DirectoryUserDevicesListing.md index baafa0c12..8a1946404 100644 --- a/build/docs/DirectoryUserDevicesListing.md +++ b/build/docs/DirectoryUserDevicesListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DisableSiteConnectionsRequest.md b/build/docs/DisableSiteConnectionsRequest.md index 7262fb7ff..49e289c49 100644 --- a/build/docs/DisableSiteConnectionsRequest.md +++ b/build/docs/DisableSiteConnectionsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DisallowedEntityLearningAssignmentItem.md b/build/docs/DisallowedEntityLearningAssignmentItem.md index 30f7ebdd6..a987ff7c1 100644 --- a/build/docs/DisallowedEntityLearningAssignmentItem.md +++ b/build/docs/DisallowedEntityLearningAssignmentItem.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DisallowedEntityLearningAssignmentReference.md b/build/docs/DisallowedEntityLearningAssignmentReference.md index 89df0224f..aeb0d0e4b 100644 --- a/build/docs/DisallowedEntityLearningAssignmentReference.md +++ b/build/docs/DisallowedEntityLearningAssignmentReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DisconnectReason.md b/build/docs/DisconnectReason.md index a628f718c..578e40572 100644 --- a/build/docs/DisconnectReason.md +++ b/build/docs/DisconnectReason.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Disposition.md b/build/docs/Disposition.md index 26cd1152c..94ad6e1db 100644 --- a/build/docs/Disposition.md +++ b/build/docs/Disposition.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DispositionParameters.md b/build/docs/DispositionParameters.md index bbe36c8f8..50c285abe 100644 --- a/build/docs/DispositionParameters.md +++ b/build/docs/DispositionParameters.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Division.md b/build/docs/Division.md index bf4f59c5c..2a147e7f7 100644 --- a/build/docs/Division.md +++ b/build/docs/Division.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DivisionEntityRef.md b/build/docs/DivisionEntityRef.md index 755245108..b2462b5c2 100644 --- a/build/docs/DivisionEntityRef.md +++ b/build/docs/DivisionEntityRef.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DivisionReference.md b/build/docs/DivisionReference.md index a49bbde07..1e5546c2f 100644 --- a/build/docs/DivisionReference.md +++ b/build/docs/DivisionReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DivisionedDomainEntityRef.md b/build/docs/DivisionedDomainEntityRef.md index cc9e49ee6..5894cfd88 100644 --- a/build/docs/DivisionedDomainEntityRef.md +++ b/build/docs/DivisionedDomainEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DivsPermittedEntityListing.md b/build/docs/DivsPermittedEntityListing.md index 1a7c4f3b1..f15a823f5 100644 --- a/build/docs/DivsPermittedEntityListing.md +++ b/build/docs/DivsPermittedEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **allDivsPermitted** | **Bool** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DncList.md b/build/docs/DncList.md index 7abbfe38c..c633c3fb6 100644 --- a/build/docs/DncList.md +++ b/build/docs/DncList.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DncListCreate.md b/build/docs/DncListCreate.md index 1bd5afb4e..a22bdc142 100644 --- a/build/docs/DncListCreate.md +++ b/build/docs/DncListCreate.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DncListDivisionView.md b/build/docs/DncListDivisionView.md index c41adddb7..decb6e2ea 100644 --- a/build/docs/DncListDivisionView.md +++ b/build/docs/DncListDivisionView.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DncListDivisionViewListing.md b/build/docs/DncListDivisionViewListing.md index a2c30889d..a1d089516 100644 --- a/build/docs/DncListDivisionViewListing.md +++ b/build/docs/DncListDivisionViewListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DncListEntityListing.md b/build/docs/DncListEntityListing.md index 31464104c..766cd99c0 100644 --- a/build/docs/DncListEntityListing.md +++ b/build/docs/DncListEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DncPatchCustomExclusionColumnsRequest.md b/build/docs/DncPatchCustomExclusionColumnsRequest.md index 913daa1b5..282f9e052 100644 --- a/build/docs/DncPatchCustomExclusionColumnsRequest.md +++ b/build/docs/DncPatchCustomExclusionColumnsRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DncPatchEmailsRequest.md b/build/docs/DncPatchEmailsRequest.md index eff1d788d..7fc7b63c0 100644 --- a/build/docs/DncPatchEmailsRequest.md +++ b/build/docs/DncPatchEmailsRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DncPatchPhoneNumbersRequest.md b/build/docs/DncPatchPhoneNumbersRequest.md index 2605150b8..b2d2320df 100644 --- a/build/docs/DncPatchPhoneNumbersRequest.md +++ b/build/docs/DncPatchPhoneNumbersRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DnclistDownloadReadyExportUri.md b/build/docs/DnclistDownloadReadyExportUri.md index 38609d3fb..eaa47f17b 100644 --- a/build/docs/DnclistDownloadReadyExportUri.md +++ b/build/docs/DnclistDownloadReadyExportUri.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DnclistDownloadReadyObject.md b/build/docs/DnclistDownloadReadyObject.md index 2d6087d35..38fffa6b3 100644 --- a/build/docs/DnclistDownloadReadyObject.md +++ b/build/docs/DnclistDownloadReadyObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DnclistImportStatusImportStatus.md b/build/docs/DnclistImportStatusImportStatus.md index 170f8d36d..3054cfad8 100644 --- a/build/docs/DnclistImportStatusImportStatus.md +++ b/build/docs/DnclistImportStatusImportStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DnclistImportStatusObject.md b/build/docs/DnclistImportStatusObject.md index 6983eefd0..828fb7127 100644 --- a/build/docs/DnclistImportStatusObject.md +++ b/build/docs/DnclistImportStatusObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DnsRecordEntry.md b/build/docs/DnsRecordEntry.md index 743fb304a..c14c9a498 100644 --- a/build/docs/DnsRecordEntry.md +++ b/build/docs/DnsRecordEntry.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DoNotSendActionSettings.md b/build/docs/DoNotSendActionSettings.md index b531a722e..98fe30f2b 100644 --- a/build/docs/DoNotSendActionSettings.md +++ b/build/docs/DoNotSendActionSettings.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Document.md b/build/docs/Document.md index f653554f0..b29e1be18 100644 --- a/build/docs/Document.md +++ b/build/docs/Document.md @@ -40,4 +40,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentArticle.md b/build/docs/DocumentArticle.md index 438ac0441..ef1ae3940 100644 --- a/build/docs/DocumentArticle.md +++ b/build/docs/DocumentArticle.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentAttribute.md b/build/docs/DocumentAttribute.md index b8f7ed4da..143335569 100644 --- a/build/docs/DocumentAttribute.md +++ b/build/docs/DocumentAttribute.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyBlock.md b/build/docs/DocumentBodyBlock.md index 620fddda3..98be774c0 100644 --- a/build/docs/DocumentBodyBlock.md +++ b/build/docs/DocumentBodyBlock.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyBlockWithHighlight.md b/build/docs/DocumentBodyBlockWithHighlight.md index 2d4da08b8..e1cae6e9f 100644 --- a/build/docs/DocumentBodyBlockWithHighlight.md +++ b/build/docs/DocumentBodyBlockWithHighlight.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyImage.md b/build/docs/DocumentBodyImage.md index eb6192235..c5fcdc9ee 100644 --- a/build/docs/DocumentBodyImage.md +++ b/build/docs/DocumentBodyImage.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyImageProperties.md b/build/docs/DocumentBodyImageProperties.md index 2627ea435..50033f130 100644 --- a/build/docs/DocumentBodyImageProperties.md +++ b/build/docs/DocumentBodyImageProperties.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyList.md b/build/docs/DocumentBodyList.md index 82fe8bb13..36843a075 100644 --- a/build/docs/DocumentBodyList.md +++ b/build/docs/DocumentBodyList.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyListBlock.md b/build/docs/DocumentBodyListBlock.md index 780cabc71..cb1afbe5c 100644 --- a/build/docs/DocumentBodyListBlock.md +++ b/build/docs/DocumentBodyListBlock.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyListBlockProperties.md b/build/docs/DocumentBodyListBlockProperties.md index 30bccf799..d3e6fba27 100644 --- a/build/docs/DocumentBodyListBlockProperties.md +++ b/build/docs/DocumentBodyListBlockProperties.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyListBlockWithHighlight.md b/build/docs/DocumentBodyListBlockWithHighlight.md index dc6d5f79c..390c228fd 100644 --- a/build/docs/DocumentBodyListBlockWithHighlight.md +++ b/build/docs/DocumentBodyListBlockWithHighlight.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyListItemProperties.md b/build/docs/DocumentBodyListItemProperties.md index 5447edb7e..a76c67a3e 100644 --- a/build/docs/DocumentBodyListItemProperties.md +++ b/build/docs/DocumentBodyListItemProperties.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyListWithHighlight.md b/build/docs/DocumentBodyListWithHighlight.md index a64a73247..dbe841481 100644 --- a/build/docs/DocumentBodyListWithHighlight.md +++ b/build/docs/DocumentBodyListWithHighlight.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyParagraph.md b/build/docs/DocumentBodyParagraph.md index dcdcc4632..c6d484ca0 100644 --- a/build/docs/DocumentBodyParagraph.md +++ b/build/docs/DocumentBodyParagraph.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyParagraphProperties.md b/build/docs/DocumentBodyParagraphProperties.md index dd703415e..b6c1ec493 100644 --- a/build/docs/DocumentBodyParagraphProperties.md +++ b/build/docs/DocumentBodyParagraphProperties.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyParagraphWithHighlight.md b/build/docs/DocumentBodyParagraphWithHighlight.md index f45fb3ff2..4719ca8a6 100644 --- a/build/docs/DocumentBodyParagraphWithHighlight.md +++ b/build/docs/DocumentBodyParagraphWithHighlight.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyRequest.md b/build/docs/DocumentBodyRequest.md index 5da650ee0..4ccbf5c51 100644 --- a/build/docs/DocumentBodyRequest.md +++ b/build/docs/DocumentBodyRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyResponse.md b/build/docs/DocumentBodyResponse.md index 163c205ac..15da9d822 100644 --- a/build/docs/DocumentBodyResponse.md +++ b/build/docs/DocumentBodyResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTable.md b/build/docs/DocumentBodyTable.md index 02ea94068..9a3f9568f 100644 --- a/build/docs/DocumentBodyTable.md +++ b/build/docs/DocumentBodyTable.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableCaptionBlock.md b/build/docs/DocumentBodyTableCaptionBlock.md index a666cca3e..dfa897a3b 100644 --- a/build/docs/DocumentBodyTableCaptionBlock.md +++ b/build/docs/DocumentBodyTableCaptionBlock.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableCaptionItem.md b/build/docs/DocumentBodyTableCaptionItem.md index 805df56b4..a32ce414b 100644 --- a/build/docs/DocumentBodyTableCaptionItem.md +++ b/build/docs/DocumentBodyTableCaptionItem.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableCellBlock.md b/build/docs/DocumentBodyTableCellBlock.md index 2edc9525f..e4b07197a 100644 --- a/build/docs/DocumentBodyTableCellBlock.md +++ b/build/docs/DocumentBodyTableCellBlock.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableCellBlockProperties.md b/build/docs/DocumentBodyTableCellBlockProperties.md index 21dd5e1d0..85611363a 100644 --- a/build/docs/DocumentBodyTableCellBlockProperties.md +++ b/build/docs/DocumentBodyTableCellBlockProperties.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableCellBlockWithHighlight.md b/build/docs/DocumentBodyTableCellBlockWithHighlight.md index 0bfb0f6e5..0a068eaf8 100644 --- a/build/docs/DocumentBodyTableCellBlockWithHighlight.md +++ b/build/docs/DocumentBodyTableCellBlockWithHighlight.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableProperties.md b/build/docs/DocumentBodyTableProperties.md index ae9170a30..4c54e4035 100644 --- a/build/docs/DocumentBodyTableProperties.md +++ b/build/docs/DocumentBodyTableProperties.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableRowBlock.md b/build/docs/DocumentBodyTableRowBlock.md index 4a9c3be93..3d73ae8a6 100644 --- a/build/docs/DocumentBodyTableRowBlock.md +++ b/build/docs/DocumentBodyTableRowBlock.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableRowBlockProperties.md b/build/docs/DocumentBodyTableRowBlockProperties.md index b54269ecc..79b5f9a9b 100644 --- a/build/docs/DocumentBodyTableRowBlockProperties.md +++ b/build/docs/DocumentBodyTableRowBlockProperties.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableRowBlockWithHighlight.md b/build/docs/DocumentBodyTableRowBlockWithHighlight.md index ca17f0e96..2331ab6db 100644 --- a/build/docs/DocumentBodyTableRowBlockWithHighlight.md +++ b/build/docs/DocumentBodyTableRowBlockWithHighlight.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyTableWithHighlight.md b/build/docs/DocumentBodyTableWithHighlight.md index 244b0d892..17dfe5a9c 100644 --- a/build/docs/DocumentBodyTableWithHighlight.md +++ b/build/docs/DocumentBodyTableWithHighlight.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyVideo.md b/build/docs/DocumentBodyVideo.md index 30638ee64..da72bfd59 100644 --- a/build/docs/DocumentBodyVideo.md +++ b/build/docs/DocumentBodyVideo.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyVideoProperties.md b/build/docs/DocumentBodyVideoProperties.md index dda154cc9..a82e28d2f 100644 --- a/build/docs/DocumentBodyVideoProperties.md +++ b/build/docs/DocumentBodyVideoProperties.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentBodyWithHighlight.md b/build/docs/DocumentBodyWithHighlight.md index 0bb6f523e..a1bbdca35 100644 --- a/build/docs/DocumentBodyWithHighlight.md +++ b/build/docs/DocumentBodyWithHighlight.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentCategoryInput.md b/build/docs/DocumentCategoryInput.md index c4548c0f4..9d4602e7a 100644 --- a/build/docs/DocumentCategoryInput.md +++ b/build/docs/DocumentCategoryInput.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentContentBlock.md b/build/docs/DocumentContentBlock.md index b66e801f8..d79a5a3d7 100644 --- a/build/docs/DocumentContentBlock.md +++ b/build/docs/DocumentContentBlock.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentContentBlockWithHighlight.md b/build/docs/DocumentContentBlockWithHighlight.md index 690f7ff23..7d994fc06 100644 --- a/build/docs/DocumentContentBlockWithHighlight.md +++ b/build/docs/DocumentContentBlockWithHighlight.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentContentHighlightIndex.md b/build/docs/DocumentContentHighlightIndex.md index 9cb170827..eacce9abc 100644 --- a/build/docs/DocumentContentHighlightIndex.md +++ b/build/docs/DocumentContentHighlightIndex.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentElementLength.md b/build/docs/DocumentElementLength.md index 36bf202ba..543bfb0f3 100644 --- a/build/docs/DocumentElementLength.md +++ b/build/docs/DocumentElementLength.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentEntityListing.md b/build/docs/DocumentEntityListing.md index 09c314bba..7c1b2c13d 100644 --- a/build/docs/DocumentEntityListing.md +++ b/build/docs/DocumentEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentFaq.md b/build/docs/DocumentFaq.md index 76b6080a4..d522ae757 100644 --- a/build/docs/DocumentFaq.md +++ b/build/docs/DocumentFaq.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentListContentBlock.md b/build/docs/DocumentListContentBlock.md index 918793d30..54d0d06c8 100644 --- a/build/docs/DocumentListContentBlock.md +++ b/build/docs/DocumentListContentBlock.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentListContentBlockWithHighlight.md b/build/docs/DocumentListContentBlockWithHighlight.md index 3161ea950..34687eb80 100644 --- a/build/docs/DocumentListContentBlockWithHighlight.md +++ b/build/docs/DocumentListContentBlockWithHighlight.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentListing.md b/build/docs/DocumentListing.md index d101dc9a2..c168c8be9 100644 --- a/build/docs/DocumentListing.md +++ b/build/docs/DocumentListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentQuery.md b/build/docs/DocumentQuery.md index 7a0f1be28..82b1ef344 100644 --- a/build/docs/DocumentQuery.md +++ b/build/docs/DocumentQuery.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentQueryClause.md b/build/docs/DocumentQueryClause.md index 159f7c774..142f08d2f 100644 --- a/build/docs/DocumentQueryClause.md +++ b/build/docs/DocumentQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentQueryInterval.md b/build/docs/DocumentQueryInterval.md index ed8b9ba28..b48c54ed9 100644 --- a/build/docs/DocumentQueryInterval.md +++ b/build/docs/DocumentQueryInterval.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentQueryPredicate.md b/build/docs/DocumentQueryPredicate.md index 829431577..63d5ca6af 100644 --- a/build/docs/DocumentQueryPredicate.md +++ b/build/docs/DocumentQueryPredicate.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentReference.md b/build/docs/DocumentReference.md index f9c03a525..d13d6d751 100644 --- a/build/docs/DocumentReference.md +++ b/build/docs/DocumentReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentTableContentBlock.md b/build/docs/DocumentTableContentBlock.md index 59c3f2fb7..9f93ee249 100644 --- a/build/docs/DocumentTableContentBlock.md +++ b/build/docs/DocumentTableContentBlock.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentTableContentBlockWithHighlight.md b/build/docs/DocumentTableContentBlockWithHighlight.md index 838488741..1296a0f59 100644 --- a/build/docs/DocumentTableContentBlockWithHighlight.md +++ b/build/docs/DocumentTableContentBlockWithHighlight.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentText.md b/build/docs/DocumentText.md index c1ad7fb3a..1652050ad 100644 --- a/build/docs/DocumentText.md +++ b/build/docs/DocumentText.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentTextProperties.md b/build/docs/DocumentTextProperties.md index 5bc20fd53..14313bdad 100644 --- a/build/docs/DocumentTextProperties.md +++ b/build/docs/DocumentTextProperties.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentThumbnail.md b/build/docs/DocumentThumbnail.md index fea60cdc1..7c4a93e8c 100644 --- a/build/docs/DocumentThumbnail.md +++ b/build/docs/DocumentThumbnail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentUpdate.md b/build/docs/DocumentUpdate.md index c51017b63..f969543ab 100644 --- a/build/docs/DocumentUpdate.md +++ b/build/docs/DocumentUpdate.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentUpload.md b/build/docs/DocumentUpload.md index 5331455e7..3c5629e9f 100644 --- a/build/docs/DocumentUpload.md +++ b/build/docs/DocumentUpload.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentVariationAnswer.md b/build/docs/DocumentVariationAnswer.md index 79cffd4bb..1bcafb575 100644 --- a/build/docs/DocumentVariationAnswer.md +++ b/build/docs/DocumentVariationAnswer.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentVariationContext.md b/build/docs/DocumentVariationContext.md index 9cca2a13a..b504943c5 100644 --- a/build/docs/DocumentVariationContext.md +++ b/build/docs/DocumentVariationContext.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentVariationRequest.md b/build/docs/DocumentVariationRequest.md index c81e49480..aa1c08e7e 100644 --- a/build/docs/DocumentVariationRequest.md +++ b/build/docs/DocumentVariationRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentVariationResponse.md b/build/docs/DocumentVariationResponse.md index 7d47f2cbe..d1ea55ca6 100644 --- a/build/docs/DocumentVariationResponse.md +++ b/build/docs/DocumentVariationResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentVariationResponseListing.md b/build/docs/DocumentVariationResponseListing.md index 122e9d851..3717d3ce1 100644 --- a/build/docs/DocumentVariationResponseListing.md +++ b/build/docs/DocumentVariationResponseListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentationResult.md b/build/docs/DocumentationResult.md index b5ab2223a..027039b89 100644 --- a/build/docs/DocumentationResult.md +++ b/build/docs/DocumentationResult.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentationSearchCriteria.md b/build/docs/DocumentationSearchCriteria.md index b2dc316c4..f3113ce63 100644 --- a/build/docs/DocumentationSearchCriteria.md +++ b/build/docs/DocumentationSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentationSearchRequest.md b/build/docs/DocumentationSearchRequest.md index b138d54bb..d0449f66e 100644 --- a/build/docs/DocumentationSearchRequest.md +++ b/build/docs/DocumentationSearchRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DocumentationSearchResponse.md b/build/docs/DocumentationSearchResponse.md index dfecfb8d0..e9cdac855 100644 --- a/build/docs/DocumentationSearchResponse.md +++ b/build/docs/DocumentationSearchResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainCapabilities.md b/build/docs/DomainCapabilities.md index 85a63a127..7f8b136c0 100644 --- a/build/docs/DomainCapabilities.md +++ b/build/docs/DomainCapabilities.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainCertificateAuthority.md b/build/docs/DomainCertificateAuthority.md index c662e4e52..1546f51b0 100644 --- a/build/docs/DomainCertificateAuthority.md +++ b/build/docs/DomainCertificateAuthority.md @@ -27,4 +27,4 @@ A certificate authority represents an organization that has issued a digital cer -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEdgeSoftwareUpdateDto.md b/build/docs/DomainEdgeSoftwareUpdateDto.md index fea505e60..902e1c08a 100644 --- a/build/docs/DomainEdgeSoftwareUpdateDto.md +++ b/build/docs/DomainEdgeSoftwareUpdateDto.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEdgeSoftwareVersionDto.md b/build/docs/DomainEdgeSoftwareVersionDto.md index a014a712c..432b5197c 100644 --- a/build/docs/DomainEdgeSoftwareVersionDto.md +++ b/build/docs/DomainEdgeSoftwareVersionDto.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEdgeSoftwareVersionDtoEntityListing.md b/build/docs/DomainEdgeSoftwareVersionDtoEntityListing.md index be7c7de88..40087b68c 100644 --- a/build/docs/DomainEdgeSoftwareVersionDtoEntityListing.md +++ b/build/docs/DomainEdgeSoftwareVersionDtoEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEntity.md b/build/docs/DomainEntity.md index 37b64d34c..99fbb6802 100644 --- a/build/docs/DomainEntity.md +++ b/build/docs/DomainEntity.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEntityListing.md b/build/docs/DomainEntityListing.md index 2c636f116..716a196fc 100644 --- a/build/docs/DomainEntityListing.md +++ b/build/docs/DomainEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEntityListingEvaluationForm.md b/build/docs/DomainEntityListingEvaluationForm.md index 73f6c2450..d718ba772 100644 --- a/build/docs/DomainEntityListingEvaluationForm.md +++ b/build/docs/DomainEntityListingEvaluationForm.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEntityListingQueryResult.md b/build/docs/DomainEntityListingQueryResult.md index 3193fe441..0a2058df0 100644 --- a/build/docs/DomainEntityListingQueryResult.md +++ b/build/docs/DomainEntityListingQueryResult.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEntityListingSurveyForm.md b/build/docs/DomainEntityListingSurveyForm.md index 1d479901e..f15007c53 100644 --- a/build/docs/DomainEntityListingSurveyForm.md +++ b/build/docs/DomainEntityListingSurveyForm.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainEntityRef.md b/build/docs/DomainEntityRef.md index 4ef65dd98..14ab08061 100644 --- a/build/docs/DomainEntityRef.md +++ b/build/docs/DomainEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainLogicalInterface.md b/build/docs/DomainLogicalInterface.md index 42847feba..4e5441e92 100644 --- a/build/docs/DomainLogicalInterface.md +++ b/build/docs/DomainLogicalInterface.md @@ -51,4 +51,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainNetworkAddress.md b/build/docs/DomainNetworkAddress.md index c557b5631..629697ebc 100644 --- a/build/docs/DomainNetworkAddress.md +++ b/build/docs/DomainNetworkAddress.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainNetworkCommandResponse.md b/build/docs/DomainNetworkCommandResponse.md index fb5b64628..b8249a6f4 100644 --- a/build/docs/DomainNetworkCommandResponse.md +++ b/build/docs/DomainNetworkCommandResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainNetworkRoute.md b/build/docs/DomainNetworkRoute.md index f1e9d1c62..bb393a65b 100644 --- a/build/docs/DomainNetworkRoute.md +++ b/build/docs/DomainNetworkRoute.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainOrgRoleDifference.md b/build/docs/DomainOrgRoleDifference.md index 0fcf94548..b5ae83db5 100644 --- a/build/docs/DomainOrgRoleDifference.md +++ b/build/docs/DomainOrgRoleDifference.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainOrganizationProduct.md b/build/docs/DomainOrganizationProduct.md index fb023fc57..bcdc13e26 100644 --- a/build/docs/DomainOrganizationProduct.md +++ b/build/docs/DomainOrganizationProduct.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainOrganizationRole.md b/build/docs/DomainOrganizationRole.md index c976ffe1e..e6e54fbb9 100644 --- a/build/docs/DomainOrganizationRole.md +++ b/build/docs/DomainOrganizationRole.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainOrganizationRoleCreate.md b/build/docs/DomainOrganizationRoleCreate.md index 0c9079998..fda8f8433 100644 --- a/build/docs/DomainOrganizationRoleCreate.md +++ b/build/docs/DomainOrganizationRoleCreate.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainOrganizationRoleUpdate.md b/build/docs/DomainOrganizationRoleUpdate.md index dcb2cbd09..f1ce84221 100644 --- a/build/docs/DomainOrganizationRoleUpdate.md +++ b/build/docs/DomainOrganizationRoleUpdate.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainPermission.md b/build/docs/DomainPermission.md index 4c5f0c7a9..bf67185dd 100644 --- a/build/docs/DomainPermission.md +++ b/build/docs/DomainPermission.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainPermissionCollection.md b/build/docs/DomainPermissionCollection.md index f603e18b6..b3116b925 100644 --- a/build/docs/DomainPermissionCollection.md +++ b/build/docs/DomainPermissionCollection.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainPermissionPolicy.md b/build/docs/DomainPermissionPolicy.md index 923ef5762..add2514ad 100644 --- a/build/docs/DomainPermissionPolicy.md +++ b/build/docs/DomainPermissionPolicy.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainPhysicalCapabilities.md b/build/docs/DomainPhysicalCapabilities.md index 09cfc6ff6..b16711121 100644 --- a/build/docs/DomainPhysicalCapabilities.md +++ b/build/docs/DomainPhysicalCapabilities.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainPhysicalInterface.md b/build/docs/DomainPhysicalInterface.md index acc0b5a8f..32f22d841 100644 --- a/build/docs/DomainPhysicalInterface.md +++ b/build/docs/DomainPhysicalInterface.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainResourceConditionNode.md b/build/docs/DomainResourceConditionNode.md index a18f0dfa3..2075c3853 100644 --- a/build/docs/DomainResourceConditionNode.md +++ b/build/docs/DomainResourceConditionNode.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainResourceConditionValue.md b/build/docs/DomainResourceConditionValue.md index 72132324d..bb282a33a 100644 --- a/build/docs/DomainResourceConditionValue.md +++ b/build/docs/DomainResourceConditionValue.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DomainRole.md b/build/docs/DomainRole.md index f950457e9..ca5a0f87f 100644 --- a/build/docs/DomainRole.md +++ b/build/docs/DomainRole.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DownloadResponse.md b/build/docs/DownloadResponse.md index 1d32070d0..3e61c2a66 100644 --- a/build/docs/DownloadResponse.md +++ b/build/docs/DownloadResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DownloadsAPI.md b/build/docs/DownloadsAPI.md index e7d9c8bd7..99675b4fe 100644 --- a/build/docs/DownloadsAPI.md +++ b/build/docs/DownloadsAPI.md @@ -65,4 +65,4 @@ DownloadsAPI.getDownload(downloadId: downloadId, contentDisposition: contentDisp [**UrlResponse**](UrlResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Draft.md b/build/docs/Draft.md index 7a9a23353..c28fe2138 100644 --- a/build/docs/Draft.md +++ b/build/docs/Draft.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DraftIntents.md b/build/docs/DraftIntents.md index 2190e332c..5111e88c5 100644 --- a/build/docs/DraftIntents.md +++ b/build/docs/DraftIntents.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DraftListing.md b/build/docs/DraftListing.md index a25beaf0b..933801552 100644 --- a/build/docs/DraftListing.md +++ b/build/docs/DraftListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DraftManipulationRequest.md b/build/docs/DraftManipulationRequest.md index 4b3695bb6..ca1d21fa3 100644 --- a/build/docs/DraftManipulationRequest.md +++ b/build/docs/DraftManipulationRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DraftRequest.md b/build/docs/DraftRequest.md index eba87aa74..723836573 100644 --- a/build/docs/DraftRequest.md +++ b/build/docs/DraftRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DraftTopicRequest.md b/build/docs/DraftTopicRequest.md index cf90dabf4..679973192 100644 --- a/build/docs/DraftTopicRequest.md +++ b/build/docs/DraftTopicRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DraftTopics.md b/build/docs/DraftTopics.md index ccd7e776f..e3f5b6ae2 100644 --- a/build/docs/DraftTopics.md +++ b/build/docs/DraftTopics.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DraftValidationResult.md b/build/docs/DraftValidationResult.md index cb84fa1c3..7d0977f42 100644 --- a/build/docs/DraftValidationResult.md +++ b/build/docs/DraftValidationResult.md @@ -12,4 +12,4 @@ Validation results -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DurationCondition.md b/build/docs/DurationCondition.md index ba7ba5f58..94ba23eed 100644 --- a/build/docs/DurationCondition.md +++ b/build/docs/DurationCondition.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DynamicContactQueueingSettings.md b/build/docs/DynamicContactQueueingSettings.md index 5331dca13..b98ff6900 100644 --- a/build/docs/DynamicContactQueueingSettings.md +++ b/build/docs/DynamicContactQueueingSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DynamicLineBalancingSettings.md b/build/docs/DynamicLineBalancingSettings.md index 01964132d..b3d764f2e 100644 --- a/build/docs/DynamicLineBalancingSettings.md +++ b/build/docs/DynamicLineBalancingSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/DynamicLineBalancingSettingsPatchRequest.md b/build/docs/DynamicLineBalancingSettingsPatchRequest.md index 4fb48f8fb..44398c968 100644 --- a/build/docs/DynamicLineBalancingSettingsPatchRequest.md +++ b/build/docs/DynamicLineBalancingSettingsPatchRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Edge.md b/build/docs/Edge.md index 5c51d3d6c..b466297b4 100644 --- a/build/docs/Edge.md +++ b/build/docs/Edge.md @@ -52,4 +52,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeAutoUpdateConfig.md b/build/docs/EdgeAutoUpdateConfig.md index 4ef553964..838121afe 100644 --- a/build/docs/EdgeAutoUpdateConfig.md +++ b/build/docs/EdgeAutoUpdateConfig.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeChangeTopicEdge.md b/build/docs/EdgeChangeTopicEdge.md index 33f9e30c9..01eb53b45 100644 --- a/build/docs/EdgeChangeTopicEdge.md +++ b/build/docs/EdgeChangeTopicEdge.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeConnectionInfo.md b/build/docs/EdgeConnectionInfo.md index a45f8f65f..0b244764b 100644 --- a/build/docs/EdgeConnectionInfo.md +++ b/build/docs/EdgeConnectionInfo.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeEntityListing.md b/build/docs/EdgeEntityListing.md index b41aaacdc..fc002d840 100644 --- a/build/docs/EdgeEntityListing.md +++ b/build/docs/EdgeEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeGroup.md b/build/docs/EdgeGroup.md index d194cc9b3..435192881 100644 --- a/build/docs/EdgeGroup.md +++ b/build/docs/EdgeGroup.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeGroupEntityListing.md b/build/docs/EdgeGroupEntityListing.md index 524b6bf88..4a121db9e 100644 --- a/build/docs/EdgeGroupEntityListing.md +++ b/build/docs/EdgeGroupEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeInterface.md b/build/docs/EdgeInterface.md index 899b993c4..b4f1100a4 100644 --- a/build/docs/EdgeInterface.md +++ b/build/docs/EdgeInterface.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeLogicalInterfacesChangeTopicDomainLogicalInterfaceChange.md b/build/docs/EdgeLogicalInterfacesChangeTopicDomainLogicalInterfaceChange.md index 6aa086754..8e7a18b4a 100644 --- a/build/docs/EdgeLogicalInterfacesChangeTopicDomainLogicalInterfaceChange.md +++ b/build/docs/EdgeLogicalInterfacesChangeTopicDomainLogicalInterfaceChange.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeLogicalInterfacesChangeTopicErrorInfo.md b/build/docs/EdgeLogicalInterfacesChangeTopicErrorInfo.md index d8fb799e0..b1bad75a2 100644 --- a/build/docs/EdgeLogicalInterfacesChangeTopicErrorInfo.md +++ b/build/docs/EdgeLogicalInterfacesChangeTopicErrorInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeLogsJob.md b/build/docs/EdgeLogsJob.md index 7f783305e..4a04d9b00 100644 --- a/build/docs/EdgeLogsJob.md +++ b/build/docs/EdgeLogsJob.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeLogsJobFile.md b/build/docs/EdgeLogsJobFile.md index 2a26f2a3a..068d5791a 100644 --- a/build/docs/EdgeLogsJobFile.md +++ b/build/docs/EdgeLogsJobFile.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeLogsJobRequest.md b/build/docs/EdgeLogsJobRequest.md index 142ee55d4..22ed503db 100644 --- a/build/docs/EdgeLogsJobRequest.md +++ b/build/docs/EdgeLogsJobRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeLogsJobResponse.md b/build/docs/EdgeLogsJobResponse.md index 9d84fe849..461f6dc6d 100644 --- a/build/docs/EdgeLogsJobResponse.md +++ b/build/docs/EdgeLogsJobResponse.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeLogsJobUploadRequest.md b/build/docs/EdgeLogsJobUploadRequest.md index 113df4320..68a8882be 100644 --- a/build/docs/EdgeLogsJobUploadRequest.md +++ b/build/docs/EdgeLogsJobUploadRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetrics.md b/build/docs/EdgeMetrics.md index b429e55bc..72658ea58 100644 --- a/build/docs/EdgeMetrics.md +++ b/build/docs/EdgeMetrics.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsDisk.md b/build/docs/EdgeMetricsDisk.md index e347baa85..d9767faf3 100644 --- a/build/docs/EdgeMetricsDisk.md +++ b/build/docs/EdgeMetricsDisk.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsMemory.md b/build/docs/EdgeMetricsMemory.md index bfa0ff562..f76ca86f6 100644 --- a/build/docs/EdgeMetricsMemory.md +++ b/build/docs/EdgeMetricsMemory.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsNetwork.md b/build/docs/EdgeMetricsNetwork.md index 5dc6170dc..562fc5bd4 100644 --- a/build/docs/EdgeMetricsNetwork.md +++ b/build/docs/EdgeMetricsNetwork.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsProcessor.md b/build/docs/EdgeMetricsProcessor.md index 5264c067a..4f6e0b70c 100644 --- a/build/docs/EdgeMetricsProcessor.md +++ b/build/docs/EdgeMetricsProcessor.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsSubsystem.md b/build/docs/EdgeMetricsSubsystem.md index c4d2bab9b..d7db25e8a 100644 --- a/build/docs/EdgeMetricsSubsystem.md +++ b/build/docs/EdgeMetricsSubsystem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsTopicEdgeMetricDisk.md b/build/docs/EdgeMetricsTopicEdgeMetricDisk.md index 8033e0285..f10a051be 100644 --- a/build/docs/EdgeMetricsTopicEdgeMetricDisk.md +++ b/build/docs/EdgeMetricsTopicEdgeMetricDisk.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsTopicEdgeMetricMemory.md b/build/docs/EdgeMetricsTopicEdgeMetricMemory.md index f2d56ea02..d0a8c2626 100644 --- a/build/docs/EdgeMetricsTopicEdgeMetricMemory.md +++ b/build/docs/EdgeMetricsTopicEdgeMetricMemory.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsTopicEdgeMetricNetworks.md b/build/docs/EdgeMetricsTopicEdgeMetricNetworks.md index 0033e5f9a..2378d551d 100644 --- a/build/docs/EdgeMetricsTopicEdgeMetricNetworks.md +++ b/build/docs/EdgeMetricsTopicEdgeMetricNetworks.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsTopicEdgeMetricProcessor.md b/build/docs/EdgeMetricsTopicEdgeMetricProcessor.md index e62fee55e..7ec7911d6 100644 --- a/build/docs/EdgeMetricsTopicEdgeMetricProcessor.md +++ b/build/docs/EdgeMetricsTopicEdgeMetricProcessor.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsTopicEdgeMetricSubsystem.md b/build/docs/EdgeMetricsTopicEdgeMetricSubsystem.md index 5e19a8307..a385a2965 100644 --- a/build/docs/EdgeMetricsTopicEdgeMetricSubsystem.md +++ b/build/docs/EdgeMetricsTopicEdgeMetricSubsystem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsTopicEdgeMetricSubsystemMedia.md b/build/docs/EdgeMetricsTopicEdgeMetricSubsystemMedia.md index 3eacf82cd..69b55bd09 100644 --- a/build/docs/EdgeMetricsTopicEdgeMetricSubsystemMedia.md +++ b/build/docs/EdgeMetricsTopicEdgeMetricSubsystemMedia.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsTopicEdgeMetrics.md b/build/docs/EdgeMetricsTopicEdgeMetrics.md index 26ccc08b3..3b4465e69 100644 --- a/build/docs/EdgeMetricsTopicEdgeMetrics.md +++ b/build/docs/EdgeMetricsTopicEdgeMetrics.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeMetricsTopicUriReference.md b/build/docs/EdgeMetricsTopicUriReference.md index 24498b1c8..2589a97ac 100644 --- a/build/docs/EdgeMetricsTopicUriReference.md +++ b/build/docs/EdgeMetricsTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeNetworkDiagnostic.md b/build/docs/EdgeNetworkDiagnostic.md index 2cb20210c..f59a49c3e 100644 --- a/build/docs/EdgeNetworkDiagnostic.md +++ b/build/docs/EdgeNetworkDiagnostic.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeNetworkDiagnosticRequest.md b/build/docs/EdgeNetworkDiagnosticRequest.md index 6b7d8bd34..4b39ae0cb 100644 --- a/build/docs/EdgeNetworkDiagnosticRequest.md +++ b/build/docs/EdgeNetworkDiagnosticRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeNetworkDiagnosticResponse.md b/build/docs/EdgeNetworkDiagnosticResponse.md index 5b20e6abe..d7b6512d7 100644 --- a/build/docs/EdgeNetworkDiagnosticResponse.md +++ b/build/docs/EdgeNetworkDiagnosticResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeRebootParameters.md b/build/docs/EdgeRebootParameters.md index f9136864d..dcfbdc954 100644 --- a/build/docs/EdgeRebootParameters.md +++ b/build/docs/EdgeRebootParameters.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeServiceStateRequest.md b/build/docs/EdgeServiceStateRequest.md index 4cd9f8d0c..75d7b4a99 100644 --- a/build/docs/EdgeServiceStateRequest.md +++ b/build/docs/EdgeServiceStateRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeSoftwareUpdateTopicDomainEdgeSoftwareUpdate.md b/build/docs/EdgeSoftwareUpdateTopicDomainEdgeSoftwareUpdate.md index 81e988bfa..3d7a44a26 100644 --- a/build/docs/EdgeSoftwareUpdateTopicDomainEdgeSoftwareUpdate.md +++ b/build/docs/EdgeSoftwareUpdateTopicDomainEdgeSoftwareUpdate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeTrunkBase.md b/build/docs/EdgeTrunkBase.md index c5e93dbf6..5300cab8c 100644 --- a/build/docs/EdgeTrunkBase.md +++ b/build/docs/EdgeTrunkBase.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeVersionInformation.md b/build/docs/EdgeVersionInformation.md index 5c33dabce..8afbc397f 100644 --- a/build/docs/EdgeVersionInformation.md +++ b/build/docs/EdgeVersionInformation.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EdgeVersionReport.md b/build/docs/EdgeVersionReport.md index f79256b0c..60d4deaf3 100644 --- a/build/docs/EdgeVersionReport.md +++ b/build/docs/EdgeVersionReport.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Education.md b/build/docs/Education.md index 2f94ec767..1aea24936 100644 --- a/build/docs/Education.md +++ b/build/docs/Education.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EffectiveConfiguration.md b/build/docs/EffectiveConfiguration.md index 944baef60..6b95742b1 100644 --- a/build/docs/EffectiveConfiguration.md +++ b/build/docs/EffectiveConfiguration.md @@ -15,4 +15,4 @@ Effective Configuration for an ClientApp. This is comprised of the integration s -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Email.md b/build/docs/Email.md index cff280206..446a37ae5 100644 --- a/build/docs/Email.md +++ b/build/docs/Email.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailAddress.md b/build/docs/EmailAddress.md index 0164de066..ed9ed00fe 100644 --- a/build/docs/EmailAddress.md +++ b/build/docs/EmailAddress.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailAttachment.md b/build/docs/EmailAttachment.md index 0fbe7c490..ceb5c5a1e 100644 --- a/build/docs/EmailAttachment.md +++ b/build/docs/EmailAttachment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailBeginTransmittingEvent.md b/build/docs/EmailBeginTransmittingEvent.md index 31bd3e3fa..b977b1cbd 100644 --- a/build/docs/EmailBeginTransmittingEvent.md +++ b/build/docs/EmailBeginTransmittingEvent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailCampaignSchedule.md b/build/docs/EmailCampaignSchedule.md index 566aa3b4f..4a7303ea4 100644 --- a/build/docs/EmailCampaignSchedule.md +++ b/build/docs/EmailCampaignSchedule.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailCampaignScheduleEntityListing.md b/build/docs/EmailCampaignScheduleEntityListing.md index cb86144f4..d579402e3 100644 --- a/build/docs/EmailCampaignScheduleEntityListing.md +++ b/build/docs/EmailCampaignScheduleEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailColumn.md b/build/docs/EmailColumn.md index 99ae1a40e..201693ad0 100644 --- a/build/docs/EmailColumn.md +++ b/build/docs/EmailColumn.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailCommunicationAnsweredEvent.md b/build/docs/EmailCommunicationAnsweredEvent.md index 7bd82de0e..3f85a40b7 100644 --- a/build/docs/EmailCommunicationAnsweredEvent.md +++ b/build/docs/EmailCommunicationAnsweredEvent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailCommunicationDispositionAppliedEvent.md b/build/docs/EmailCommunicationDispositionAppliedEvent.md index 8fb6179bd..66bd73653 100644 --- a/build/docs/EmailCommunicationDispositionAppliedEvent.md +++ b/build/docs/EmailCommunicationDispositionAppliedEvent.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailCommunicationEndedEvent.md b/build/docs/EmailCommunicationEndedEvent.md index 1f711e7a4..3c40fde13 100644 --- a/build/docs/EmailCommunicationEndedEvent.md +++ b/build/docs/EmailCommunicationEndedEvent.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailCommunicationRepliedEvent.md b/build/docs/EmailCommunicationRepliedEvent.md index 151c99e69..93288b98b 100644 --- a/build/docs/EmailCommunicationRepliedEvent.md +++ b/build/docs/EmailCommunicationRepliedEvent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailCommunicationSentMessageEvent.md b/build/docs/EmailCommunicationSentMessageEvent.md index 0f3cce2ee..b9d2e5d0e 100644 --- a/build/docs/EmailCommunicationSentMessageEvent.md +++ b/build/docs/EmailCommunicationSentMessageEvent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailConfig.md b/build/docs/EmailConfig.md index c8491ae49..ae4c5b051 100644 --- a/build/docs/EmailConfig.md +++ b/build/docs/EmailConfig.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailConversation.md b/build/docs/EmailConversation.md index 6e33a5f4e..e86665dc9 100644 --- a/build/docs/EmailConversation.md +++ b/build/docs/EmailConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailConversationEntityListing.md b/build/docs/EmailConversationEntityListing.md index d72fe8d66..50833b4ad 100644 --- a/build/docs/EmailConversationEntityListing.md +++ b/build/docs/EmailConversationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailEndTransferEvent.md b/build/docs/EmailEndTransferEvent.md index 3e596d778..682ff6086 100644 --- a/build/docs/EmailEndTransferEvent.md +++ b/build/docs/EmailEndTransferEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailErrorInfo.md b/build/docs/EmailErrorInfo.md index f84119318..bfe481c4f 100644 --- a/build/docs/EmailErrorInfo.md +++ b/build/docs/EmailErrorInfo.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailExternalEstablishedEvent.md b/build/docs/EmailExternalEstablishedEvent.md index 615faeb55..38907bbba 100644 --- a/build/docs/EmailExternalEstablishedEvent.md +++ b/build/docs/EmailExternalEstablishedEvent.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailFlowEstablishedEvent.md b/build/docs/EmailFlowEstablishedEvent.md index 09272074a..12cea4b74 100644 --- a/build/docs/EmailFlowEstablishedEvent.md +++ b/build/docs/EmailFlowEstablishedEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailHoldUpdatedEvent.md b/build/docs/EmailHoldUpdatedEvent.md index f95806c36..c228c7865 100644 --- a/build/docs/EmailHoldUpdatedEvent.md +++ b/build/docs/EmailHoldUpdatedEvent.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailInitialConfiguration.md b/build/docs/EmailInitialConfiguration.md index 5777be252..66da48889 100644 --- a/build/docs/EmailInitialConfiguration.md +++ b/build/docs/EmailInitialConfiguration.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailMediaParticipant.md b/build/docs/EmailMediaParticipant.md index 462b7ac80..308beb55a 100644 --- a/build/docs/EmailMediaParticipant.md +++ b/build/docs/EmailMediaParticipant.md @@ -50,4 +50,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailMediaPolicy.md b/build/docs/EmailMediaPolicy.md index 4de09da41..8be8cc30d 100644 --- a/build/docs/EmailMediaPolicy.md +++ b/build/docs/EmailMediaPolicy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailMediaPolicyConditions.md b/build/docs/EmailMediaPolicyConditions.md index a4c9345dd..38c96f8c8 100644 --- a/build/docs/EmailMediaPolicyConditions.md +++ b/build/docs/EmailMediaPolicyConditions.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailMediaSettings.md b/build/docs/EmailMediaSettings.md index 9db1c67a9..2a29ddf0d 100644 --- a/build/docs/EmailMediaSettings.md +++ b/build/docs/EmailMediaSettings.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailMessage.md b/build/docs/EmailMessage.md index 1d480eab2..d12980126 100644 --- a/build/docs/EmailMessage.md +++ b/build/docs/EmailMessage.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailMessagePreview.md b/build/docs/EmailMessagePreview.md index 5ade813da..2495110a3 100644 --- a/build/docs/EmailMessagePreview.md +++ b/build/docs/EmailMessagePreview.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailMessagePreviewListing.md b/build/docs/EmailMessagePreviewListing.md index 3f6fd407d..2d4b25cac 100644 --- a/build/docs/EmailMessagePreviewListing.md +++ b/build/docs/EmailMessagePreviewListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailMessageReply.md b/build/docs/EmailMessageReply.md index caaaf91c9..f594acfbb 100644 --- a/build/docs/EmailMessageReply.md +++ b/build/docs/EmailMessageReply.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailOutboundDomainResult.md b/build/docs/EmailOutboundDomainResult.md index 407700864..e268c7ebf 100644 --- a/build/docs/EmailOutboundDomainResult.md +++ b/build/docs/EmailOutboundDomainResult.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailProgressTransferEvent.md b/build/docs/EmailProgressTransferEvent.md index 887e40cf7..060d17e46 100644 --- a/build/docs/EmailProgressTransferEvent.md +++ b/build/docs/EmailProgressTransferEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailRoutingEstablishedEvent.md b/build/docs/EmailRoutingEstablishedEvent.md index 3cec4ce96..9ce0d3c1f 100644 --- a/build/docs/EmailRoutingEstablishedEvent.md +++ b/build/docs/EmailRoutingEstablishedEvent.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailRoutingTransferEvent.md b/build/docs/EmailRoutingTransferEvent.md index 8c7a00064..6f73130aa 100644 --- a/build/docs/EmailRoutingTransferEvent.md +++ b/build/docs/EmailRoutingTransferEvent.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailSettings.md b/build/docs/EmailSettings.md index e86181570..d9d8aec45 100644 --- a/build/docs/EmailSettings.md +++ b/build/docs/EmailSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailSetup.md b/build/docs/EmailSetup.md index 5e5e56b11..26aa58567 100644 --- a/build/docs/EmailSetup.md +++ b/build/docs/EmailSetup.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailUserEstablishedEvent.md b/build/docs/EmailUserEstablishedEvent.md index f205c5f6b..89b91385f 100644 --- a/build/docs/EmailUserEstablishedEvent.md +++ b/build/docs/EmailUserEstablishedEvent.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailUserTransferEvent.md b/build/docs/EmailUserTransferEvent.md index bd010db9f..5733f6221 100644 --- a/build/docs/EmailUserTransferEvent.md +++ b/build/docs/EmailUserTransferEvent.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailsAPI.md b/build/docs/EmailsAPI.md index b83f43c68..0e50cb448 100644 --- a/build/docs/EmailsAPI.md +++ b/build/docs/EmailsAPI.md @@ -105,4 +105,4 @@ EmailsAPI.patchEmailsSettings(body: body) { (response, error) in [**EmailSettings**](EmailSettings) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmailsSettings.md b/build/docs/EmailsSettings.md index b33bd2b8a..659011994 100644 --- a/build/docs/EmailsSettings.md +++ b/build/docs/EmailsSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmbeddedIntegration.md b/build/docs/EmbeddedIntegration.md index fbe940614..c943f64d6 100644 --- a/build/docs/EmbeddedIntegration.md +++ b/build/docs/EmbeddedIntegration.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmergencyCallFlow.md b/build/docs/EmergencyCallFlow.md index 9b5a2ed48..b5b99306e 100644 --- a/build/docs/EmergencyCallFlow.md +++ b/build/docs/EmergencyCallFlow.md @@ -12,4 +12,4 @@ An emergency flow associates a call flow to use in an emergency with the ivr(s) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmergencyGroup.md b/build/docs/EmergencyGroup.md index fc73e9c0f..3915b9a4b 100644 --- a/build/docs/EmergencyGroup.md +++ b/build/docs/EmergencyGroup.md @@ -25,4 +25,4 @@ A group of emergency call flows to use in an emergency. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmergencyGroupDivisionView.md b/build/docs/EmergencyGroupDivisionView.md index 301f8a127..6e01b670c 100644 --- a/build/docs/EmergencyGroupDivisionView.md +++ b/build/docs/EmergencyGroupDivisionView.md @@ -14,4 +14,4 @@ A group of call flows. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmergencyGroupDivisionViewEntityListing.md b/build/docs/EmergencyGroupDivisionViewEntityListing.md index e6e36d5bd..3e88d45be 100644 --- a/build/docs/EmergencyGroupDivisionViewEntityListing.md +++ b/build/docs/EmergencyGroupDivisionViewEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmergencyGroupListing.md b/build/docs/EmergencyGroupListing.md index 33160f3bd..74ca3bb0b 100644 --- a/build/docs/EmergencyGroupListing.md +++ b/build/docs/EmergencyGroupListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmergencyLocation.md b/build/docs/EmergencyLocation.md index 7b668e011..cc576b3d2 100644 --- a/build/docs/EmergencyLocation.md +++ b/build/docs/EmergencyLocation.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmpathyScore.md b/build/docs/EmpathyScore.md index b175e3c5b..3a91caee6 100644 --- a/build/docs/EmpathyScore.md +++ b/build/docs/EmpathyScore.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmployeeEngagementAPI.md b/build/docs/EmployeeEngagementAPI.md index 9b6a5d193..422f9f6e6 100644 --- a/build/docs/EmployeeEngagementAPI.md +++ b/build/docs/EmployeeEngagementAPI.md @@ -264,4 +264,4 @@ EmployeeEngagementAPI.postEmployeeengagementRecognitions(body: body) { (response [**RecognitionBase**](RecognitionBase) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EmployerInfo.md b/build/docs/EmployerInfo.md index 8fe9b1c59..b221cce7c 100644 --- a/build/docs/EmployerInfo.md +++ b/build/docs/EmployerInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Empty.md b/build/docs/Empty.md index 18d4fe68f..3761dae1e 100644 --- a/build/docs/Empty.md +++ b/build/docs/Empty.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EncryptionKey.md b/build/docs/EncryptionKey.md index b67bf520d..e8c479838 100644 --- a/build/docs/EncryptionKey.md +++ b/build/docs/EncryptionKey.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EncryptionKeyEntityListing.md b/build/docs/EncryptionKeyEntityListing.md index dee556e44..512f2a8cc 100644 --- a/build/docs/EncryptionKeyEntityListing.md +++ b/build/docs/EncryptionKeyEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EndConsultTransferEvent.md b/build/docs/EndConsultTransferEvent.md index ce2e307bd..cb9abd6cd 100644 --- a/build/docs/EndConsultTransferEvent.md +++ b/build/docs/EndConsultTransferEvent.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EndTransferEvent.md b/build/docs/EndTransferEvent.md index 21bdeb37d..56bf8ff35 100644 --- a/build/docs/EndTransferEvent.md +++ b/build/docs/EndTransferEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Endpoint.md b/build/docs/Endpoint.md index 85821112d..327d774c6 100644 --- a/build/docs/Endpoint.md +++ b/build/docs/Endpoint.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EngineIntegration.md b/build/docs/EngineIntegration.md index 1ef8ebdc0..e8af29bd5 100644 --- a/build/docs/EngineIntegration.md +++ b/build/docs/EngineIntegration.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Entity.md b/build/docs/Entity.md index d9da02ee5..d4e5d848f 100644 --- a/build/docs/Entity.md +++ b/build/docs/Entity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EntityChange.md b/build/docs/EntityChange.md index 31eef8747..f513e4db1 100644 --- a/build/docs/EntityChange.md +++ b/build/docs/EntityChange.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EntityListing.md b/build/docs/EntityListing.md index f69818268..f4ff3362f 100644 --- a/build/docs/EntityListing.md +++ b/build/docs/EntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EntityReference.md b/build/docs/EntityReference.md index 53e09401b..f7c5c1753 100644 --- a/build/docs/EntityReference.md +++ b/build/docs/EntityReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EntityTypeCriteria.md b/build/docs/EntityTypeCriteria.md index f492d57dc..2cad7cb4e 100644 --- a/build/docs/EntityTypeCriteria.md +++ b/build/docs/EntityTypeCriteria.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ErrorBody.md b/build/docs/ErrorBody.md index 695c39043..f9fbed774 100644 --- a/build/docs/ErrorBody.md +++ b/build/docs/ErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ErrorDetails.md b/build/docs/ErrorDetails.md index c623931e2..c82cc13ed 100644 --- a/build/docs/ErrorDetails.md +++ b/build/docs/ErrorDetails.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ErrorInfo.md b/build/docs/ErrorInfo.md index f46c60894..5bf933e94 100644 --- a/build/docs/ErrorInfo.md +++ b/build/docs/ErrorInfo.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EstimateAvailableFullDayTimeOffRequest.md b/build/docs/EstimateAvailableFullDayTimeOffRequest.md index d49b3623b..0972aaf5c 100644 --- a/build/docs/EstimateAvailableFullDayTimeOffRequest.md +++ b/build/docs/EstimateAvailableFullDayTimeOffRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EstimateAvailableFullDayTimeOffResponse.md b/build/docs/EstimateAvailableFullDayTimeOffResponse.md index 6ae1fc690..61cb0c84c 100644 --- a/build/docs/EstimateAvailableFullDayTimeOffResponse.md +++ b/build/docs/EstimateAvailableFullDayTimeOffResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EstimateAvailablePartialDayTimeOffRequest.md b/build/docs/EstimateAvailablePartialDayTimeOffRequest.md index f08078d29..769e05907 100644 --- a/build/docs/EstimateAvailablePartialDayTimeOffRequest.md +++ b/build/docs/EstimateAvailablePartialDayTimeOffRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EstimateAvailablePartialDayTimeOffResponse.md b/build/docs/EstimateAvailablePartialDayTimeOffResponse.md index 1b8be44ef..5543daa9f 100644 --- a/build/docs/EstimateAvailablePartialDayTimeOffResponse.md +++ b/build/docs/EstimateAvailablePartialDayTimeOffResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EstimateAvailableTimeOffRequest.md b/build/docs/EstimateAvailableTimeOffRequest.md index 6a6dbb513..da62f8316 100644 --- a/build/docs/EstimateAvailableTimeOffRequest.md +++ b/build/docs/EstimateAvailableTimeOffRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EstimateAvailableTimeOffResponse.md b/build/docs/EstimateAvailableTimeOffResponse.md index 9ac6eefb0..218da57c7 100644 --- a/build/docs/EstimateAvailableTimeOffResponse.md +++ b/build/docs/EstimateAvailableTimeOffResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EstimateJobAsyncResponse.md b/build/docs/EstimateJobAsyncResponse.md index 99656d171..12f7ffd3f 100644 --- a/build/docs/EstimateJobAsyncResponse.md +++ b/build/docs/EstimateJobAsyncResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EstimatedWaitTimePredictions.md b/build/docs/EstimatedWaitTimePredictions.md index c53b5290c..cd18cc82b 100644 --- a/build/docs/EstimatedWaitTimePredictions.md +++ b/build/docs/EstimatedWaitTimePredictions.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Evaluation.md b/build/docs/Evaluation.md index c701b4220..61d8abd8a 100644 --- a/build/docs/Evaluation.md +++ b/build/docs/Evaluation.md @@ -42,4 +42,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAggregateDataContainer.md b/build/docs/EvaluationAggregateDataContainer.md index 072aaf460..709286029 100644 --- a/build/docs/EvaluationAggregateDataContainer.md +++ b/build/docs/EvaluationAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAggregateQueryClause.md b/build/docs/EvaluationAggregateQueryClause.md index 1b653d43b..0a71aadbd 100644 --- a/build/docs/EvaluationAggregateQueryClause.md +++ b/build/docs/EvaluationAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAggregateQueryFilter.md b/build/docs/EvaluationAggregateQueryFilter.md index b1c38f729..a8760c5c2 100644 --- a/build/docs/EvaluationAggregateQueryFilter.md +++ b/build/docs/EvaluationAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAggregateQueryPredicate.md b/build/docs/EvaluationAggregateQueryPredicate.md index b192d902b..2be609b09 100644 --- a/build/docs/EvaluationAggregateQueryPredicate.md +++ b/build/docs/EvaluationAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAggregateQueryResponse.md b/build/docs/EvaluationAggregateQueryResponse.md index 9ec9fdb08..7ac317ca5 100644 --- a/build/docs/EvaluationAggregateQueryResponse.md +++ b/build/docs/EvaluationAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAggregationQuery.md b/build/docs/EvaluationAggregationQuery.md index 7ff92f9bd..82ddf88cc 100644 --- a/build/docs/EvaluationAggregationQuery.md +++ b/build/docs/EvaluationAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAggregationQueryMe.md b/build/docs/EvaluationAggregationQueryMe.md index 313110f87..d3095e745 100644 --- a/build/docs/EvaluationAggregationQueryMe.md +++ b/build/docs/EvaluationAggregationQueryMe.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAggregationView.md b/build/docs/EvaluationAggregationView.md index 3cc2a26b5..6bc73316f 100644 --- a/build/docs/EvaluationAggregationView.md +++ b/build/docs/EvaluationAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationAssignment.md b/build/docs/EvaluationAssignment.md index 24ff86af1..cf00a419b 100644 --- a/build/docs/EvaluationAssignment.md +++ b/build/docs/EvaluationAssignment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationCreateBody.md b/build/docs/EvaluationCreateBody.md index 55d75641c..984ec2b8f 100644 --- a/build/docs/EvaluationCreateBody.md +++ b/build/docs/EvaluationCreateBody.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationCreateCalibration.md b/build/docs/EvaluationCreateCalibration.md index 2fa05fea9..73a044e9f 100644 --- a/build/docs/EvaluationCreateCalibration.md +++ b/build/docs/EvaluationCreateCalibration.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationCreateConversation.md b/build/docs/EvaluationCreateConversation.md index 905e1ba7b..82d01172e 100644 --- a/build/docs/EvaluationCreateConversation.md +++ b/build/docs/EvaluationCreateConversation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationCreateEvalForm.md b/build/docs/EvaluationCreateEvalForm.md index f7a3f160c..84f867536 100644 --- a/build/docs/EvaluationCreateEvalForm.md +++ b/build/docs/EvaluationCreateEvalForm.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationCreateQueue.md b/build/docs/EvaluationCreateQueue.md index 2179e311c..8c44d1bcc 100644 --- a/build/docs/EvaluationCreateQueue.md +++ b/build/docs/EvaluationCreateQueue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationCreateUser.md b/build/docs/EvaluationCreateUser.md index af57009a4..0efd1b32f 100644 --- a/build/docs/EvaluationCreateUser.md +++ b/build/docs/EvaluationCreateUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationDetailQueryClause.md b/build/docs/EvaluationDetailQueryClause.md index b7e3948d6..0787f5565 100644 --- a/build/docs/EvaluationDetailQueryClause.md +++ b/build/docs/EvaluationDetailQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationDetailQueryFilter.md b/build/docs/EvaluationDetailQueryFilter.md index 8ab794185..cbb9ee18a 100644 --- a/build/docs/EvaluationDetailQueryFilter.md +++ b/build/docs/EvaluationDetailQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationDetailQueryPredicate.md b/build/docs/EvaluationDetailQueryPredicate.md index 91f98102e..e32be410f 100644 --- a/build/docs/EvaluationDetailQueryPredicate.md +++ b/build/docs/EvaluationDetailQueryPredicate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationEntityListing.md b/build/docs/EvaluationEntityListing.md index 525bddbe0..b80589c20 100644 --- a/build/docs/EvaluationEntityListing.md +++ b/build/docs/EvaluationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationForm.md b/build/docs/EvaluationForm.md index bd57bfc00..2cc4ff1e6 100644 --- a/build/docs/EvaluationForm.md +++ b/build/docs/EvaluationForm.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationFormAndScoringSet.md b/build/docs/EvaluationFormAndScoringSet.md index e17aff1c1..a759f9d8d 100644 --- a/build/docs/EvaluationFormAndScoringSet.md +++ b/build/docs/EvaluationFormAndScoringSet.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationFormResponse.md b/build/docs/EvaluationFormResponse.md index 87241fb79..995edabda 100644 --- a/build/docs/EvaluationFormResponse.md +++ b/build/docs/EvaluationFormResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationFormResponseEntityListing.md b/build/docs/EvaluationFormResponseEntityListing.md index 5d91ca8a8..a87a62605 100644 --- a/build/docs/EvaluationFormResponseEntityListing.md +++ b/build/docs/EvaluationFormResponseEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQualityV2TopicCalibration.md b/build/docs/EvaluationQualityV2TopicCalibration.md index b58679860..d090b0c53 100644 --- a/build/docs/EvaluationQualityV2TopicCalibration.md +++ b/build/docs/EvaluationQualityV2TopicCalibration.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQualityV2TopicEvaluationReference.md b/build/docs/EvaluationQualityV2TopicEvaluationReference.md index bc5d5b014..5ed607dbd 100644 --- a/build/docs/EvaluationQualityV2TopicEvaluationReference.md +++ b/build/docs/EvaluationQualityV2TopicEvaluationReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQualityV2TopicEvaluationScoringSet.md b/build/docs/EvaluationQualityV2TopicEvaluationScoringSet.md index 7ab6af138..085246c31 100644 --- a/build/docs/EvaluationQualityV2TopicEvaluationScoringSet.md +++ b/build/docs/EvaluationQualityV2TopicEvaluationScoringSet.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQualityV2TopicEvaluationSource.md b/build/docs/EvaluationQualityV2TopicEvaluationSource.md index 746a90c8a..c292a3370 100644 --- a/build/docs/EvaluationQualityV2TopicEvaluationSource.md +++ b/build/docs/EvaluationQualityV2TopicEvaluationSource.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQualityV2TopicEvaluationV2.md b/build/docs/EvaluationQualityV2TopicEvaluationV2.md index 44702f746..d475c4199 100644 --- a/build/docs/EvaluationQualityV2TopicEvaluationV2.md +++ b/build/docs/EvaluationQualityV2TopicEvaluationV2.md @@ -46,4 +46,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQualityV2TopicUser.md b/build/docs/EvaluationQualityV2TopicUser.md index fd96c5450..e564c5817 100644 --- a/build/docs/EvaluationQualityV2TopicUser.md +++ b/build/docs/EvaluationQualityV2TopicUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQuestion.md b/build/docs/EvaluationQuestion.md index 23b979843..182c81939 100644 --- a/build/docs/EvaluationQuestion.md +++ b/build/docs/EvaluationQuestion.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQuestionGroup.md b/build/docs/EvaluationQuestionGroup.md index e7b5c0fa1..3d4af0e84 100644 --- a/build/docs/EvaluationQuestionGroup.md +++ b/build/docs/EvaluationQuestionGroup.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQuestionGroupScore.md b/build/docs/EvaluationQuestionGroupScore.md index 6401a8dac..168df9011 100644 --- a/build/docs/EvaluationQuestionGroupScore.md +++ b/build/docs/EvaluationQuestionGroupScore.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationQuestionScore.md b/build/docs/EvaluationQuestionScore.md index b9b0389fe..9ab2a1099 100644 --- a/build/docs/EvaluationQuestionScore.md +++ b/build/docs/EvaluationQuestionScore.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationReference.md b/build/docs/EvaluationReference.md index 51eedef68..834cee63d 100644 --- a/build/docs/EvaluationReference.md +++ b/build/docs/EvaluationReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationResponse.md b/build/docs/EvaluationResponse.md index bd2b4a0e7..54a6bd4a5 100644 --- a/build/docs/EvaluationResponse.md +++ b/build/docs/EvaluationResponse.md @@ -41,4 +41,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationScoringSet.md b/build/docs/EvaluationScoringSet.md index 44a92bb3b..e10885757 100644 --- a/build/docs/EvaluationScoringSet.md +++ b/build/docs/EvaluationScoringSet.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationSettings.md b/build/docs/EvaluationSettings.md index 9c5d7b664..048666172 100644 --- a/build/docs/EvaluationSettings.md +++ b/build/docs/EvaluationSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationSettingsAssignee.md b/build/docs/EvaluationSettingsAssignee.md index da4ae52c0..5a42845c3 100644 --- a/build/docs/EvaluationSettingsAssignee.md +++ b/build/docs/EvaluationSettingsAssignee.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationSource.md b/build/docs/EvaluationSource.md index a4b117027..4d43dff75 100644 --- a/build/docs/EvaluationSource.md +++ b/build/docs/EvaluationSource.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluationVersion.md b/build/docs/EvaluationVersion.md index 1a807db1e..ffed41111 100644 --- a/build/docs/EvaluationVersion.md +++ b/build/docs/EvaluationVersion.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluatorActivity.md b/build/docs/EvaluatorActivity.md index c6dfe2444..fc4c01b00 100644 --- a/build/docs/EvaluatorActivity.md +++ b/build/docs/EvaluatorActivity.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EvaluatorActivityEntityListing.md b/build/docs/EvaluatorActivityEntityListing.md index 6e430af0e..fd0decdcb 100644 --- a/build/docs/EvaluatorActivityEntityListing.md +++ b/build/docs/EvaluatorActivityEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Event.md b/build/docs/Event.md index a8e3858cd..dd9048574 100644 --- a/build/docs/Event.md +++ b/build/docs/Event.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventAction.md b/build/docs/EventAction.md index c041b240d..59dde9dbe 100644 --- a/build/docs/EventAction.md +++ b/build/docs/EventAction.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventAggregatesQueryRequest.md b/build/docs/EventAggregatesQueryRequest.md index ec7e18b68..808d03157 100644 --- a/build/docs/EventAggregatesQueryRequest.md +++ b/build/docs/EventAggregatesQueryRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventAggregatesResponse.md b/build/docs/EventAggregatesResponse.md index 9ea1f67af..11cf0839c 100644 --- a/build/docs/EventAggregatesResponse.md +++ b/build/docs/EventAggregatesResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventCondition.md b/build/docs/EventCondition.md index 5e9fb4483..7d5f8bfd0 100644 --- a/build/docs/EventCondition.md +++ b/build/docs/EventCondition.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventDefinition.md b/build/docs/EventDefinition.md index 5a287bb1b..c104877aa 100644 --- a/build/docs/EventDefinition.md +++ b/build/docs/EventDefinition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventDefinitionAggregates.md b/build/docs/EventDefinitionAggregates.md index 6f49dbef2..b4b31ee4e 100644 --- a/build/docs/EventDefinitionAggregates.md +++ b/build/docs/EventDefinitionAggregates.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventDefinitionListing.md b/build/docs/EventDefinitionListing.md index ed3b5cea0..67e3743da 100644 --- a/build/docs/EventDefinitionListing.md +++ b/build/docs/EventDefinitionListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventError.md b/build/docs/EventError.md index 2deb99161..386a0cbd9 100644 --- a/build/docs/EventError.md +++ b/build/docs/EventError.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventListing.md b/build/docs/EventListing.md index b22143510..8877f31fa 100644 --- a/build/docs/EventListing.md +++ b/build/docs/EventListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventLog.md b/build/docs/EventLog.md index 522d72169..ad71be47e 100644 --- a/build/docs/EventLog.md +++ b/build/docs/EventLog.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventMessage.md b/build/docs/EventMessage.md index 51e8c5ac9..f6e9209d1 100644 --- a/build/docs/EventMessage.md +++ b/build/docs/EventMessage.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventQueryRequest.md b/build/docs/EventQueryRequest.md index 13e94dd11..c108539c6 100644 --- a/build/docs/EventQueryRequest.md +++ b/build/docs/EventQueryRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventQueryResponse.md b/build/docs/EventQueryResponse.md index d8afd60c7..4a941bc6e 100644 --- a/build/docs/EventQueryResponse.md +++ b/build/docs/EventQueryResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventSession.md b/build/docs/EventSession.md index 8136cc7f8..c8ded51dc 100644 --- a/build/docs/EventSession.md +++ b/build/docs/EventSession.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventSetting.md b/build/docs/EventSetting.md index 697523787..951e75d90 100644 --- a/build/docs/EventSetting.md +++ b/build/docs/EventSetting.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/EventsAPI.md b/build/docs/EventsAPI.md index 6ec4d005c..998fcc39b 100644 --- a/build/docs/EventsAPI.md +++ b/build/docs/EventsAPI.md @@ -160,4 +160,4 @@ EventsAPI.postEventsUsersRoutingstatus(body: body) { (response, error) in [**BatchEventResponse**](BatchEventResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExecuteRecordingJobsQuery.md b/build/docs/ExecuteRecordingJobsQuery.md index cfc46e1e9..3865fccd4 100644 --- a/build/docs/ExecuteRecordingJobsQuery.md +++ b/build/docs/ExecuteRecordingJobsQuery.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExecutionDataEntity.md b/build/docs/ExecutionDataEntity.md index 40842806d..0b3489df6 100644 --- a/build/docs/ExecutionDataEntity.md +++ b/build/docs/ExecutionDataEntity.md @@ -14,4 +14,4 @@ Represents an individual result of an execution data lookup -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExecutionDataFlowSettingsResponse.md b/build/docs/ExecutionDataFlowSettingsResponse.md index d3ca4df72..d2be5e3f5 100644 --- a/build/docs/ExecutionDataFlowSettingsResponse.md +++ b/build/docs/ExecutionDataFlowSettingsResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExecutionDataGlobalSettingsResponse.md b/build/docs/ExecutionDataGlobalSettingsResponse.md index 69ca63828..dd628d39f 100644 --- a/build/docs/ExecutionDataGlobalSettingsResponse.md +++ b/build/docs/ExecutionDataGlobalSettingsResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExecutionDataRequest.md b/build/docs/ExecutionDataRequest.md index ac394868d..3fbe36257 100644 --- a/build/docs/ExecutionDataRequest.md +++ b/build/docs/ExecutionDataRequest.md @@ -11,4 +11,4 @@ Used to retrieve a set of executionData history by the respective ids -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExecutionDataSettingsRequest.md b/build/docs/ExecutionDataSettingsRequest.md index 218b78133..654be1804 100644 --- a/build/docs/ExecutionDataSettingsRequest.md +++ b/build/docs/ExecutionDataSettingsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExpandableWebDeployment.md b/build/docs/ExpandableWebDeployment.md index 01da5f468..1e7ab6a20 100644 --- a/build/docs/ExpandableWebDeployment.md +++ b/build/docs/ExpandableWebDeployment.md @@ -24,4 +24,4 @@ Details about a Web Deployment -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExpandableWebDeploymentEntityListing.md b/build/docs/ExpandableWebDeploymentEntityListing.md index 59844284f..75d490b51 100644 --- a/build/docs/ExpandableWebDeploymentEntityListing.md +++ b/build/docs/ExpandableWebDeploymentEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExpansionCriterium.md b/build/docs/ExpansionCriterium.md index dacf1d604..760205b4f 100644 --- a/build/docs/ExpansionCriterium.md +++ b/build/docs/ExpansionCriterium.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExpiredEdgeListing.md b/build/docs/ExpiredEdgeListing.md index b0aa87004..c1f9ec76f 100644 --- a/build/docs/ExpiredEdgeListing.md +++ b/build/docs/ExpiredEdgeListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExportScriptRequest.md b/build/docs/ExportScriptRequest.md index 815b9551a..2fb592cbe 100644 --- a/build/docs/ExportScriptRequest.md +++ b/build/docs/ExportScriptRequest.md @@ -12,4 +12,4 @@ Creating an exported script via Download Service -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExportScriptResponse.md b/build/docs/ExportScriptResponse.md index 91df54844..6dde72aaa 100644 --- a/build/docs/ExportScriptResponse.md +++ b/build/docs/ExportScriptResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExportUri.md b/build/docs/ExportUri.md index 4e124aff3..ff0232644 100644 --- a/build/docs/ExportUri.md +++ b/build/docs/ExportUri.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Extension.md b/build/docs/Extension.md index 7a8be475e..e8275f7b0 100644 --- a/build/docs/Extension.md +++ b/build/docs/Extension.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExtensionEntityListing.md b/build/docs/ExtensionEntityListing.md index 3db9db5fe..2a3db9f65 100644 --- a/build/docs/ExtensionEntityListing.md +++ b/build/docs/ExtensionEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExtensionPool.md b/build/docs/ExtensionPool.md index 66c57ee65..5bf85da6a 100644 --- a/build/docs/ExtensionPool.md +++ b/build/docs/ExtensionPool.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExtensionPoolDivisionView.md b/build/docs/ExtensionPoolDivisionView.md index 3c4d4d900..3d39bf33e 100644 --- a/build/docs/ExtensionPoolDivisionView.md +++ b/build/docs/ExtensionPoolDivisionView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExtensionPoolDivisionViewEntityListing.md b/build/docs/ExtensionPoolDivisionViewEntityListing.md index ca033b5ff..21a86b90b 100644 --- a/build/docs/ExtensionPoolDivisionViewEntityListing.md +++ b/build/docs/ExtensionPoolDivisionViewEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExtensionPoolEntityListing.md b/build/docs/ExtensionPoolEntityListing.md index 92b1ab9ef..26dc0fefb 100644 --- a/build/docs/ExtensionPoolEntityListing.md +++ b/build/docs/ExtensionPoolEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContact.md b/build/docs/ExternalContact.md index 7c7ab4c1b..a028f159f 100644 --- a/build/docs/ExternalContact.md +++ b/build/docs/ExternalContact.md @@ -41,4 +41,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactReference.md b/build/docs/ExternalContactReference.md index cee3a5ca8..c2878cd1e 100644 --- a/build/docs/ExternalContactReference.md +++ b/build/docs/ExternalContactReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsAPI.md b/build/docs/ExternalContactsAPI.md index 6c7f98c83..bcb7f105a 100644 --- a/build/docs/ExternalContactsAPI.md +++ b/build/docs/ExternalContactsAPI.md @@ -9,6 +9,7 @@ All URIs are relative to *https://api.mypurecloud.com* | [**deleteExternalcontactsContactsSchema**](ExternalContactsAPI#deleteExternalcontactsContactsSchema) | Delete a schema | | [**deleteExternalcontactsExternalsource**](ExternalContactsAPI#deleteExternalcontactsExternalsource) | Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable. | | [**deleteExternalcontactsImportCsvSetting**](ExternalContactsAPI#deleteExternalcontactsImportCsvSetting) | Delete settings for CSV import | +| [**deleteExternalcontactsImportSetting**](ExternalContactsAPI#deleteExternalcontactsImportSetting) | Delete Settings | | [**deleteExternalcontactsOrganization**](ExternalContactsAPI#deleteExternalcontactsOrganization) | Delete an external organization | | [**deleteExternalcontactsOrganizationNote**](ExternalContactsAPI#deleteExternalcontactsOrganizationNote) | Delete a note for an external organization | | [**deleteExternalcontactsOrganizationTrustor**](ExternalContactsAPI#deleteExternalcontactsOrganizationTrustor) | Unlink the Trustor for this External Organization | @@ -30,6 +31,10 @@ All URIs are relative to *https://api.mypurecloud.com* | [**getExternalcontactsImportCsvSettings**](ExternalContactsAPI#getExternalcontactsImportCsvSettings) | Retrieve all settings for organization filtered by externalSettingsId if provided | | [**getExternalcontactsImportCsvUploadDetails**](ExternalContactsAPI#getExternalcontactsImportCsvUploadDetails) | Get details for CSV upload | | [**getExternalcontactsImportCsvUploadPreview**](ExternalContactsAPI#getExternalcontactsImportCsvUploadPreview) | Get preview for CSV upload | +| [**getExternalcontactsImportJob**](ExternalContactsAPI#getExternalcontactsImportJob) | Get job based on id | +| [**getExternalcontactsImportJobs**](ExternalContactsAPI#getExternalcontactsImportJobs) | List jobs for organization | +| [**getExternalcontactsImportSetting**](ExternalContactsAPI#getExternalcontactsImportSetting) | Get setting based on id | +| [**getExternalcontactsImportSettings**](ExternalContactsAPI#getExternalcontactsImportSettings) | List settings for organization | | [**getExternalcontactsOrganization**](ExternalContactsAPI#getExternalcontactsOrganization) | Fetch an external organization | | [**getExternalcontactsOrganizationContacts**](ExternalContactsAPI#getExternalcontactsOrganizationContacts) | Search for external contacts in an external organization | | [**getExternalcontactsOrganizationNote**](ExternalContactsAPI#getExternalcontactsOrganizationNote) | Fetch a note for an external organization | @@ -73,6 +78,8 @@ All URIs are relative to *https://api.mypurecloud.com* | [**postExternalcontactsImportCsvJobs**](ExternalContactsAPI#postExternalcontactsImportCsvJobs) | Create CSV import job | | [**postExternalcontactsImportCsvSettings**](ExternalContactsAPI#postExternalcontactsImportCsvSettings) | Create settings for CSV import | | [**postExternalcontactsImportCsvUploads**](ExternalContactsAPI#postExternalcontactsImportCsvUploads) | Get url for CSV upload | +| [**postExternalcontactsImportJobs**](ExternalContactsAPI#postExternalcontactsImportJobs) | Create a new job | +| [**postExternalcontactsImportSettings**](ExternalContactsAPI#postExternalcontactsImportSettings) | Create a new settings | | [**postExternalcontactsMergeContacts**](ExternalContactsAPI#postExternalcontactsMergeContacts) | Merge two contacts into a new contact record | | [**postExternalcontactsOrganizationNotes**](ExternalContactsAPI#postExternalcontactsOrganizationNotes) | Create a note for an external organization | | [**postExternalcontactsOrganizations**](ExternalContactsAPI#postExternalcontactsOrganizations) | Create an external organization | @@ -84,6 +91,8 @@ All URIs are relative to *https://api.mypurecloud.com* | [**putExternalcontactsConversation**](ExternalContactsAPI#putExternalcontactsConversation) | Associate/disassociate an external contact with a conversation | | [**putExternalcontactsExternalsource**](ExternalContactsAPI#putExternalcontactsExternalsource) | Update an External Source | | [**putExternalcontactsImportCsvSetting**](ExternalContactsAPI#putExternalcontactsImportCsvSetting) | Update settings for CSV import | +| [**putExternalcontactsImportJob**](ExternalContactsAPI#putExternalcontactsImportJob) | Update Job's workflow status | +| [**putExternalcontactsImportSetting**](ExternalContactsAPI#putExternalcontactsImportSetting) | Update settings | | [**putExternalcontactsOrganization**](ExternalContactsAPI#putExternalcontactsOrganization) | Update an external organization | | [**putExternalcontactsOrganizationNote**](ExternalContactsAPI#putExternalcontactsOrganizationNote) | Update a note for an external organization | | [**putExternalcontactsOrganizationTrustorTrustorId**](ExternalContactsAPI#putExternalcontactsOrganizationTrustorTrustorId) | Links a Trustor with an External Organization | @@ -344,6 +353,55 @@ ExternalContactsAPI.deleteExternalcontactsImportCsvSetting(settingsId: settingsI `nil` (empty response body) +## deleteExternalcontactsImportSetting + + + +> Void deleteExternalcontactsImportSetting(settingsId) + +Delete Settings + + + +Wraps DELETE /api/v2/externalcontacts/import/settings/{settingsId} + +Requires ANY permissions: + +* externalContacts:importSettings:delete + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let settingsId: String = "" // Settings id + +// Code example +ExternalContactsAPI.deleteExternalcontactsImportSetting(settingsId: settingsId) { (error) in + if let error = error { + dump(error) + } else { + print("ExternalContactsAPI.deleteExternalcontactsImportSetting was successful") + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **settingsId** | **String**| Settings id | | + + +### Return type + +`nil` (empty response body) + + ## deleteExternalcontactsOrganization @@ -605,7 +663,7 @@ ExternalContactsAPI.getExternalcontactsContact(contactId: contactId, expand: exp -> [EntityListing](EntityListing) getExternalcontactsContactIdentifiers(contactId) +> [ContactIdentifierListing](ContactIdentifierListing) getExternalcontactsContactIdentifiers(contactId) List the identifiers for a contact @@ -648,7 +706,7 @@ ExternalContactsAPI.getExternalcontactsContactIdentifiers(contactId: contactId) ### Return type -[**EntityListing**](EntityListing) +[**ContactIdentifierListing**](ContactIdentifierListing) ## getExternalcontactsContactJourneySessions @@ -1444,6 +1502,218 @@ ExternalContactsAPI.getExternalcontactsImportCsvUploadPreview(uploadId: uploadId [**CsvUploadPreviewResponse**](CsvUploadPreviewResponse) +## getExternalcontactsImportJob + + + +> [ContactImportJobResponse](ContactImportJobResponse) getExternalcontactsImportJob(jobId) + +Get job based on id + + + +Wraps GET /api/v2/externalcontacts/import/jobs/{jobId} + +Requires ANY permissions: + +* externalContacts:importJob:view + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let jobId: String = "" // Job id + +// Code example +ExternalContactsAPI.getExternalcontactsImportJob(jobId: jobId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("ExternalContactsAPI.getExternalcontactsImportJob was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **jobId** | **String**| Job id | | + + +### Return type + +[**ContactImportJobResponse**](ContactImportJobResponse) + + +## getExternalcontactsImportJobs + + + +> [ContactImportJobEntityListing](ContactImportJobEntityListing) getExternalcontactsImportJobs(after, pageSize, sortOrder, jobStatus) + +List jobs for organization + + + +Wraps GET /api/v2/externalcontacts/import/jobs + +Requires ANY permissions: + +* externalContacts:importJob:viewAll + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 100. +let sortOrder: ExternalContactsAPI.SortOrder_getExternalcontactsImportJobs = ExternalContactsAPI.SortOrder_getExternalcontactsImportJobs.enummember // Direction of sorting. +let jobStatus: ExternalContactsAPI.JobStatus_getExternalcontactsImportJobs = ExternalContactsAPI.JobStatus_getExternalcontactsImportJobs.enummember // Search term to filter by jobStatus + +// Code example +ExternalContactsAPI.getExternalcontactsImportJobs(after: after, pageSize: pageSize, sortOrder: sortOrder, jobStatus: jobStatus) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("ExternalContactsAPI.getExternalcontactsImportJobs was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **after** | **String**| The cursor that points to the end of the set of entities that has been returned. | [optional] | +| **pageSize** | **String**| Number of entities to return. Maximum of 100. | [optional] | +| **sortOrder** | **String**| Direction of sorting. | [optional]
**Values**: ascending ("Ascending"), descending ("Descending") | +| **jobStatus** | **String**| Search term to filter by jobStatus | [optional]
**Values**: created ("Created"), running ("Running"), completed ("Completed"), failed ("Failed"), cancelled ("Cancelled") | + + +### Return type + +[**ContactImportJobEntityListing**](ContactImportJobEntityListing) + + +## getExternalcontactsImportSetting + + + +> [ContactImportSettings](ContactImportSettings) getExternalcontactsImportSetting(settingsId) + +Get setting based on id + + + +Wraps GET /api/v2/externalcontacts/import/settings/{settingsId} + +Requires ANY permissions: + +* externalContacts:importSettings:view + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let settingsId: String = "" // Settings id + +// Code example +ExternalContactsAPI.getExternalcontactsImportSetting(settingsId: settingsId) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("ExternalContactsAPI.getExternalcontactsImportSetting was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **settingsId** | **String**| Settings id | | + + +### Return type + +[**ContactImportSettings**](ContactImportSettings) + + +## getExternalcontactsImportSettings + + + +> [ContactImportSettingsEntityListing](ContactImportSettingsEntityListing) getExternalcontactsImportSettings(after, pageSize, sortOrder, name) + +List settings for organization + + + +Wraps GET /api/v2/externalcontacts/import/settings + +Requires ANY permissions: + +* externalContacts:importSettings:viewAll + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let after: String = "" // The cursor that points to the end of the set of entities that has been returned. +let pageSize: String = "" // Number of entities to return. Maximum of 100. +let sortOrder: ExternalContactsAPI.SortOrder_getExternalcontactsImportSettings = ExternalContactsAPI.SortOrder_getExternalcontactsImportSettings.enummember // Direction of sorting. +let name: String = "" // Search term to filter by settings name + +// Code example +ExternalContactsAPI.getExternalcontactsImportSettings(after: after, pageSize: pageSize, sortOrder: sortOrder, name: name) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("ExternalContactsAPI.getExternalcontactsImportSettings was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **after** | **String**| The cursor that points to the end of the set of entities that has been returned. | [optional] | +| **pageSize** | **String**| Number of entities to return. Maximum of 100. | [optional] | +| **sortOrder** | **String**| Direction of sorting. | [optional]
**Values**: ascending ("Ascending"), descending ("Descending") | +| **name** | **String**| Search term to filter by settings name | [optional] | + + +### Return type + +[**ContactImportSettingsEntityListing**](ContactImportSettingsEntityListing) + + ## getExternalcontactsOrganization @@ -3680,6 +3950,106 @@ ExternalContactsAPI.postExternalcontactsImportCsvUploads(body: body) { (response [**CsvUploadResponse**](CsvUploadResponse) +## postExternalcontactsImportJobs + + + +> [ContactImportJobResponse](ContactImportJobResponse) postExternalcontactsImportJobs(body) + +Create a new job + + + +Wraps POST /api/v2/externalcontacts/import/jobs + +Requires ANY permissions: + +* externalContacts:importJob:add + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let body: ContactImportJobRequest = new ContactImportJobRequest(...) // Job + +// Code example +ExternalContactsAPI.postExternalcontactsImportJobs(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("ExternalContactsAPI.postExternalcontactsImportJobs was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **body** | [**ContactImportJobRequest**](ContactImportJobRequest)| Job | | + + +### Return type + +[**ContactImportJobResponse**](ContactImportJobResponse) + + +## postExternalcontactsImportSettings + + + +> [ContactImportSettings](ContactImportSettings) postExternalcontactsImportSettings(body) + +Create a new settings + + + +Wraps POST /api/v2/externalcontacts/import/settings + +Requires ANY permissions: + +* externalContacts:importSettings:add + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let body: ContactImportSettings = new ContactImportSettings(...) // Setting + +// Code example +ExternalContactsAPI.postExternalcontactsImportSettings(body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("ExternalContactsAPI.postExternalcontactsImportSettings was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **body** | [**ContactImportSettings**](ContactImportSettings)| Setting | | + + +### Return type + +[**ContactImportSettings**](ContactImportSettings) + + ## postExternalcontactsMergeContacts @@ -4255,6 +4625,110 @@ ExternalContactsAPI.putExternalcontactsImportCsvSetting(settingsId: settingsId, [**CsvSettings**](CsvSettings) +## putExternalcontactsImportJob + + + +> [ContactImportJobStatusUpdateResponse](ContactImportJobStatusUpdateResponse) putExternalcontactsImportJob(jobId, body) + +Update Job's workflow status + + + +Wraps PUT /api/v2/externalcontacts/import/jobs/{jobId} + +Requires ANY permissions: + +* externalContacts:importJob:edit + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let jobId: String = "" // Job id +let body: ContactImportJobStatusUpdateRequest = new ContactImportJobStatusUpdateRequest(...) // Status of the Job's workflow + +// Code example +ExternalContactsAPI.putExternalcontactsImportJob(jobId: jobId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("ExternalContactsAPI.putExternalcontactsImportJob was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **jobId** | **String**| Job id | | +| **body** | [**ContactImportJobStatusUpdateRequest**](ContactImportJobStatusUpdateRequest)| Status of the Job's workflow | | + + +### Return type + +[**ContactImportJobStatusUpdateResponse**](ContactImportJobStatusUpdateResponse) + + +## putExternalcontactsImportSetting + + + +> [ContactImportSettings](ContactImportSettings) putExternalcontactsImportSetting(settingsId, body) + +Update settings + + + +Wraps PUT /api/v2/externalcontacts/import/settings/{settingsId} + +Requires ANY permissions: + +* externalContacts:importSettings:edit + +### Example + +```{"language":"swift"} +import PureCloudPlatformClientV2 + +PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" +PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." + +let settingsId: String = "" // Settings id +let body: ContactImportSettings = new ContactImportSettings(...) // Setting + +// Code example +ExternalContactsAPI.putExternalcontactsImportSetting(settingsId: settingsId, body: body) { (response, error) in + if let error = error { + dump(error) + } else if let response = response { + print("ExternalContactsAPI.putExternalcontactsImportSetting was successful") + dump(response) + } +} +``` + +### Parameters + + +| Name | Type | Description | Notes | +| ------------- | ------------- | ------------- | ------------- | +| **settingsId** | **String**| Settings id | | +| **body** | [**ContactImportSettings**](ContactImportSettings)| Setting | | + + +### Return type + +[**ContactImportSettings**](ContactImportSettings) + + ## putExternalcontactsOrganization @@ -4520,4 +4994,4 @@ ExternalContactsAPI.putExternalcontactsRelationship(relationshipId: relationship [**Relationship**](Relationship) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicContact.md b/build/docs/ExternalContactsContactChangedTopicContact.md index c388fb6df..2ff2173c2 100644 --- a/build/docs/ExternalContactsContactChangedTopicContact.md +++ b/build/docs/ExternalContactsContactChangedTopicContact.md @@ -43,4 +43,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicContactAddress.md b/build/docs/ExternalContactsContactChangedTopicContactAddress.md index 5b300961e..f16d154e3 100644 --- a/build/docs/ExternalContactsContactChangedTopicContactAddress.md +++ b/build/docs/ExternalContactsContactChangedTopicContactAddress.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicDataSchema.md b/build/docs/ExternalContactsContactChangedTopicDataSchema.md index 0b956bf23..28772b57a 100644 --- a/build/docs/ExternalContactsContactChangedTopicDataSchema.md +++ b/build/docs/ExternalContactsContactChangedTopicDataSchema.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicDivision.md b/build/docs/ExternalContactsContactChangedTopicDivision.md index b8909b29a..f4dab32ec 100644 --- a/build/docs/ExternalContactsContactChangedTopicDivision.md +++ b/build/docs/ExternalContactsContactChangedTopicDivision.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicExternalId.md b/build/docs/ExternalContactsContactChangedTopicExternalId.md index 19ec779d7..5697d7580 100644 --- a/build/docs/ExternalContactsContactChangedTopicExternalId.md +++ b/build/docs/ExternalContactsContactChangedTopicExternalId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicExternalOrganization.md b/build/docs/ExternalContactsContactChangedTopicExternalOrganization.md index 30a8b4ab4..2b3e92e29 100644 --- a/build/docs/ExternalContactsContactChangedTopicExternalOrganization.md +++ b/build/docs/ExternalContactsContactChangedTopicExternalOrganization.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicExternalSource.md b/build/docs/ExternalContactsContactChangedTopicExternalSource.md index df49dcbff..292da3cb2 100644 --- a/build/docs/ExternalContactsContactChangedTopicExternalSource.md +++ b/build/docs/ExternalContactsContactChangedTopicExternalSource.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicFacebookId.md b/build/docs/ExternalContactsContactChangedTopicFacebookId.md index 528bb9f0c..a07c8899d 100644 --- a/build/docs/ExternalContactsContactChangedTopicFacebookId.md +++ b/build/docs/ExternalContactsContactChangedTopicFacebookId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicFacebookScopedId.md b/build/docs/ExternalContactsContactChangedTopicFacebookScopedId.md index 2eb1dfe35..d9ee8061b 100644 --- a/build/docs/ExternalContactsContactChangedTopicFacebookScopedId.md +++ b/build/docs/ExternalContactsContactChangedTopicFacebookScopedId.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicInstagramId.md b/build/docs/ExternalContactsContactChangedTopicInstagramId.md index 008665c72..c642c75a9 100644 --- a/build/docs/ExternalContactsContactChangedTopicInstagramId.md +++ b/build/docs/ExternalContactsContactChangedTopicInstagramId.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicInstagramScopedId.md b/build/docs/ExternalContactsContactChangedTopicInstagramScopedId.md index a46cac4e1..45358bac7 100644 --- a/build/docs/ExternalContactsContactChangedTopicInstagramScopedId.md +++ b/build/docs/ExternalContactsContactChangedTopicInstagramScopedId.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicLineId.md b/build/docs/ExternalContactsContactChangedTopicLineId.md index 58213fa1c..213ac5097 100644 --- a/build/docs/ExternalContactsContactChangedTopicLineId.md +++ b/build/docs/ExternalContactsContactChangedTopicLineId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicLineUserId.md b/build/docs/ExternalContactsContactChangedTopicLineUserId.md index f44575e7c..d6f9b76ca 100644 --- a/build/docs/ExternalContactsContactChangedTopicLineUserId.md +++ b/build/docs/ExternalContactsContactChangedTopicLineUserId.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicMergeOperation.md b/build/docs/ExternalContactsContactChangedTopicMergeOperation.md index 47739518c..73e8f3fa1 100644 --- a/build/docs/ExternalContactsContactChangedTopicMergeOperation.md +++ b/build/docs/ExternalContactsContactChangedTopicMergeOperation.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicObject.md b/build/docs/ExternalContactsContactChangedTopicObject.md index 96ef9a2d4..aa9e71404 100644 --- a/build/docs/ExternalContactsContactChangedTopicObject.md +++ b/build/docs/ExternalContactsContactChangedTopicObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicPhoneNumber.md b/build/docs/ExternalContactsContactChangedTopicPhoneNumber.md index 1f6379542..88172ab77 100644 --- a/build/docs/ExternalContactsContactChangedTopicPhoneNumber.md +++ b/build/docs/ExternalContactsContactChangedTopicPhoneNumber.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicTicker.md b/build/docs/ExternalContactsContactChangedTopicTicker.md index c2c1318da..00942849a 100644 --- a/build/docs/ExternalContactsContactChangedTopicTicker.md +++ b/build/docs/ExternalContactsContactChangedTopicTicker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicTwitterId.md b/build/docs/ExternalContactsContactChangedTopicTwitterId.md index f0dcaa956..5eb9e4c57 100644 --- a/build/docs/ExternalContactsContactChangedTopicTwitterId.md +++ b/build/docs/ExternalContactsContactChangedTopicTwitterId.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactChangedTopicWhatsAppId.md b/build/docs/ExternalContactsContactChangedTopicWhatsAppId.md index b1526fea9..2988ea227 100644 --- a/build/docs/ExternalContactsContactChangedTopicWhatsAppId.md +++ b/build/docs/ExternalContactsContactChangedTopicWhatsAppId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactNoteChangedTopicDivision.md b/build/docs/ExternalContactsContactNoteChangedTopicDivision.md index be176ca2d..43b38d2fa 100644 --- a/build/docs/ExternalContactsContactNoteChangedTopicDivision.md +++ b/build/docs/ExternalContactsContactNoteChangedTopicDivision.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactNoteChangedTopicNote.md b/build/docs/ExternalContactsContactNoteChangedTopicNote.md index 7f344de4d..8e1cd6edf 100644 --- a/build/docs/ExternalContactsContactNoteChangedTopicNote.md +++ b/build/docs/ExternalContactsContactNoteChangedTopicNote.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsContactNoteChangedTopicUser.md b/build/docs/ExternalContactsContactNoteChangedTopicUser.md index 4df34c5ac..75b397fc2 100644 --- a/build/docs/ExternalContactsContactNoteChangedTopicUser.md +++ b/build/docs/ExternalContactsContactNoteChangedTopicUser.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsEntity.md b/build/docs/ExternalContactsEntity.md index f55957168..aa7e94aad 100644 --- a/build/docs/ExternalContactsEntity.md +++ b/build/docs/ExternalContactsEntity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationChangedTopicContactAddress.md b/build/docs/ExternalContactsOrganizationChangedTopicContactAddress.md index d8beb4754..add184cfa 100644 --- a/build/docs/ExternalContactsOrganizationChangedTopicContactAddress.md +++ b/build/docs/ExternalContactsOrganizationChangedTopicContactAddress.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationChangedTopicDivision.md b/build/docs/ExternalContactsOrganizationChangedTopicDivision.md index f29bdd07e..0dc545a91 100644 --- a/build/docs/ExternalContactsOrganizationChangedTopicDivision.md +++ b/build/docs/ExternalContactsOrganizationChangedTopicDivision.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationChangedTopicExternalOrganization.md b/build/docs/ExternalContactsOrganizationChangedTopicExternalOrganization.md index 1bcefbf62..1951db159 100644 --- a/build/docs/ExternalContactsOrganizationChangedTopicExternalOrganization.md +++ b/build/docs/ExternalContactsOrganizationChangedTopicExternalOrganization.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationChangedTopicObject.md b/build/docs/ExternalContactsOrganizationChangedTopicObject.md index 93e1d19e8..60772a781 100644 --- a/build/docs/ExternalContactsOrganizationChangedTopicObject.md +++ b/build/docs/ExternalContactsOrganizationChangedTopicObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationChangedTopicPhoneNumber.md b/build/docs/ExternalContactsOrganizationChangedTopicPhoneNumber.md index 94a122c5c..0a4af41c8 100644 --- a/build/docs/ExternalContactsOrganizationChangedTopicPhoneNumber.md +++ b/build/docs/ExternalContactsOrganizationChangedTopicPhoneNumber.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationChangedTopicTicker.md b/build/docs/ExternalContactsOrganizationChangedTopicTicker.md index cf4c79d00..f7bd4b3ea 100644 --- a/build/docs/ExternalContactsOrganizationChangedTopicTicker.md +++ b/build/docs/ExternalContactsOrganizationChangedTopicTicker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationChangedTopicTwitterId.md b/build/docs/ExternalContactsOrganizationChangedTopicTwitterId.md index 8214cdea9..2e42e0b85 100644 --- a/build/docs/ExternalContactsOrganizationChangedTopicTwitterId.md +++ b/build/docs/ExternalContactsOrganizationChangedTopicTwitterId.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationNoteChangedTopicDivision.md b/build/docs/ExternalContactsOrganizationNoteChangedTopicDivision.md index 8a4a2f2af..51f284fc0 100644 --- a/build/docs/ExternalContactsOrganizationNoteChangedTopicDivision.md +++ b/build/docs/ExternalContactsOrganizationNoteChangedTopicDivision.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationNoteChangedTopicNote.md b/build/docs/ExternalContactsOrganizationNoteChangedTopicNote.md index c2698c6be..1a4f206fa 100644 --- a/build/docs/ExternalContactsOrganizationNoteChangedTopicNote.md +++ b/build/docs/ExternalContactsOrganizationNoteChangedTopicNote.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsOrganizationNoteChangedTopicUser.md b/build/docs/ExternalContactsOrganizationNoteChangedTopicUser.md index 3cccf66bd..fc735761a 100644 --- a/build/docs/ExternalContactsOrganizationNoteChangedTopicUser.md +++ b/build/docs/ExternalContactsOrganizationNoteChangedTopicUser.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicContactAddress.md b/build/docs/ExternalContactsRelationshipChangedTopicContactAddress.md index be1de54ea..41c52dcac 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicContactAddress.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicContactAddress.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicDivision.md b/build/docs/ExternalContactsRelationshipChangedTopicDivision.md index 381728712..f7ae73c4a 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicDivision.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicDivision.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicExternalOrganization.md b/build/docs/ExternalContactsRelationshipChangedTopicExternalOrganization.md index 3068afe68..af3d6f29d 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicExternalOrganization.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicExternalOrganization.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicObject.md b/build/docs/ExternalContactsRelationshipChangedTopicObject.md index 48b64152e..6013d34c7 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicObject.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicPhoneNumber.md b/build/docs/ExternalContactsRelationshipChangedTopicPhoneNumber.md index ffe06e144..133ef0665 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicPhoneNumber.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicPhoneNumber.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicRelationship.md b/build/docs/ExternalContactsRelationshipChangedTopicRelationship.md index 3facf26bb..5b607ab0c 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicRelationship.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicRelationship.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicTicker.md b/build/docs/ExternalContactsRelationshipChangedTopicTicker.md index d104c647d..5be52a97a 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicTicker.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicTicker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicTwitterId.md b/build/docs/ExternalContactsRelationshipChangedTopicTwitterId.md index 5f8295053..d2dbe28e6 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicTwitterId.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicTwitterId.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsRelationshipChangedTopicUser.md b/build/docs/ExternalContactsRelationshipChangedTopicUser.md index ee0014df0..a954e2688 100644 --- a/build/docs/ExternalContactsRelationshipChangedTopicUser.md +++ b/build/docs/ExternalContactsRelationshipChangedTopicUser.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsSettings.md b/build/docs/ExternalContactsSettings.md index 33deffa64..b07964e87 100644 --- a/build/docs/ExternalContactsSettings.md +++ b/build/docs/ExternalContactsSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicContact.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicContact.md index 6abb152b4..7009a0ad7 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicContact.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicContact.md @@ -43,4 +43,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicContactAddress.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicContactAddress.md index bbb684378..4a3b7bcd5 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicContactAddress.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicContactAddress.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicDataSchema.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicDataSchema.md index a80870dbd..84925b025 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicDataSchema.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicDataSchema.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicDivision.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicDivision.md index ca1ada456..5ff240dd2 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicDivision.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicDivision.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalId.md index 1848d0079..f32c7f812 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalOrganization.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalOrganization.md index 144b8aad3..7af5ef3f4 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalOrganization.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalOrganization.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalSource.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalSource.md index f1851cb6f..5f276f6cb 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalSource.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicExternalSource.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicFacebookId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicFacebookId.md index c8c632c99..4383232fe 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicFacebookId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicFacebookId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicFacebookScopedId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicFacebookScopedId.md index 5f3bae6c9..68a2b5302 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicFacebookScopedId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicFacebookScopedId.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicInstagramId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicInstagramId.md index 53f688632..8dc43af1e 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicInstagramId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicInstagramId.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicInstagramScopedId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicInstagramScopedId.md index 1539bd5d8..8fe1df826 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicInstagramScopedId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicInstagramScopedId.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicLineId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicLineId.md index da91265ba..afa3faf8c 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicLineId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicLineId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicLineUserId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicLineUserId.md index 36a32d0fe..c317089a0 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicLineUserId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicLineUserId.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicMergeOperation.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicMergeOperation.md index 11c5a7a1b..7067b8e06 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicMergeOperation.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicMergeOperation.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicObject.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicObject.md index 7ad32fc20..822e6b09b 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicObject.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicPhoneNumber.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicPhoneNumber.md index 6c97ba3ae..9d0c0eff3 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicPhoneNumber.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicPhoneNumber.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicTicker.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicTicker.md index d47ee264b..97f4b4991 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicTicker.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicTicker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicTwitterId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicTwitterId.md index 1ba1dcdf3..1ee2029e5 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicTwitterId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicTwitterId.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalContactsUnresolvedContactChangedTopicWhatsAppId.md b/build/docs/ExternalContactsUnresolvedContactChangedTopicWhatsAppId.md index 6e6687857..02ce9848e 100644 --- a/build/docs/ExternalContactsUnresolvedContactChangedTopicWhatsAppId.md +++ b/build/docs/ExternalContactsUnresolvedContactChangedTopicWhatsAppId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalDataSource.md b/build/docs/ExternalDataSource.md index 298c67ef5..aa8ca29f2 100644 --- a/build/docs/ExternalDataSource.md +++ b/build/docs/ExternalDataSource.md @@ -12,4 +12,4 @@ Describes a link to a record in an external system that contributed data to a Re -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalEstablishedEvent.md b/build/docs/ExternalEstablishedEvent.md index 135be770c..6cf167d33 100644 --- a/build/docs/ExternalEstablishedEvent.md +++ b/build/docs/ExternalEstablishedEvent.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalId.md b/build/docs/ExternalId.md index b2a7a99ba..e7447ed22 100644 --- a/build/docs/ExternalId.md +++ b/build/docs/ExternalId.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDataItem.md b/build/docs/ExternalMetricDataItem.md index 1e614c8de..fd312b8f3 100644 --- a/build/docs/ExternalMetricDataItem.md +++ b/build/docs/ExternalMetricDataItem.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDataProcessedItem.md b/build/docs/ExternalMetricDataProcessedItem.md index d53a9cdc0..b24a9a7a4 100644 --- a/build/docs/ExternalMetricDataProcessedItem.md +++ b/build/docs/ExternalMetricDataProcessedItem.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDataUnprocessedItem.md b/build/docs/ExternalMetricDataUnprocessedItem.md index 51814bd76..b9390430f 100644 --- a/build/docs/ExternalMetricDataUnprocessedItem.md +++ b/build/docs/ExternalMetricDataUnprocessedItem.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDataWriteRequest.md b/build/docs/ExternalMetricDataWriteRequest.md index 8133a1bbf..e610253b8 100644 --- a/build/docs/ExternalMetricDataWriteRequest.md +++ b/build/docs/ExternalMetricDataWriteRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDataWriteResponse.md b/build/docs/ExternalMetricDataWriteResponse.md index 7e8f787de..8d6712178 100644 --- a/build/docs/ExternalMetricDataWriteResponse.md +++ b/build/docs/ExternalMetricDataWriteResponse.md @@ -12,4 +12,4 @@ External metric data write response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDefinition.md b/build/docs/ExternalMetricDefinition.md index 1eb48087e..915cff59b 100644 --- a/build/docs/ExternalMetricDefinition.md +++ b/build/docs/ExternalMetricDefinition.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDefinitionCreateRequest.md b/build/docs/ExternalMetricDefinitionCreateRequest.md index a5cccf42e..92fa6f207 100644 --- a/build/docs/ExternalMetricDefinitionCreateRequest.md +++ b/build/docs/ExternalMetricDefinitionCreateRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDefinitionListing.md b/build/docs/ExternalMetricDefinitionListing.md index 01e927e40..e3b355f16 100644 --- a/build/docs/ExternalMetricDefinitionListing.md +++ b/build/docs/ExternalMetricDefinitionListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalMetricDefinitionUpdateRequest.md b/build/docs/ExternalMetricDefinitionUpdateRequest.md index 0678b1f59..8f11177b1 100644 --- a/build/docs/ExternalMetricDefinitionUpdateRequest.md +++ b/build/docs/ExternalMetricDefinitionUpdateRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalOrganization.md b/build/docs/ExternalOrganization.md index d7b8dcf3b..a26621794 100644 --- a/build/docs/ExternalOrganization.md +++ b/build/docs/ExternalOrganization.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalOrganizationListing.md b/build/docs/ExternalOrganizationListing.md index 5dff65f9a..81d2cf4d9 100644 --- a/build/docs/ExternalOrganizationListing.md +++ b/build/docs/ExternalOrganizationListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **partialResults** | **Bool** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalOrganizationTrustorLink.md b/build/docs/ExternalOrganizationTrustorLink.md index a5a275d18..b3a5ee35e 100644 --- a/build/docs/ExternalOrganizationTrustorLink.md +++ b/build/docs/ExternalOrganizationTrustorLink.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalSegment.md b/build/docs/ExternalSegment.md index aa6c2d90d..6daf4da7e 100644 --- a/build/docs/ExternalSegment.md +++ b/build/docs/ExternalSegment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ExternalSource.md b/build/docs/ExternalSource.md index d0a802270..ea3d4f452 100644 --- a/build/docs/ExternalSource.md +++ b/build/docs/ExternalSource.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookAppCredentials.md b/build/docs/FacebookAppCredentials.md index 73362550b..9158c5f2f 100644 --- a/build/docs/FacebookAppCredentials.md +++ b/build/docs/FacebookAppCredentials.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookId.md b/build/docs/FacebookId.md index 4a5034d82..f29d028c4 100644 --- a/build/docs/FacebookId.md +++ b/build/docs/FacebookId.md @@ -12,4 +12,4 @@ User information for a Facebook user interacting with a page or app -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookIntegration.md b/build/docs/FacebookIntegration.md index ec73b8153..2f471d3ee 100644 --- a/build/docs/FacebookIntegration.md +++ b/build/docs/FacebookIntegration.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookIntegrationEntityListing.md b/build/docs/FacebookIntegrationEntityListing.md index 20871c4b9..e30ed4f5c 100644 --- a/build/docs/FacebookIntegrationEntityListing.md +++ b/build/docs/FacebookIntegrationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookIntegrationRequest.md b/build/docs/FacebookIntegrationRequest.md index 9bd7b081b..ca8c928da 100644 --- a/build/docs/FacebookIntegrationRequest.md +++ b/build/docs/FacebookIntegrationRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookIntegrationUpdateRequest.md b/build/docs/FacebookIntegrationUpdateRequest.md index 912291213..6a766180e 100644 --- a/build/docs/FacebookIntegrationUpdateRequest.md +++ b/build/docs/FacebookIntegrationUpdateRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookPermission.md b/build/docs/FacebookPermission.md index 76d9ec4a0..391975b33 100644 --- a/build/docs/FacebookPermission.md +++ b/build/docs/FacebookPermission.md @@ -12,4 +12,4 @@ Facebook Permissions Model -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookPermissionEntityListing.md b/build/docs/FacebookPermissionEntityListing.md index df8ec6860..317312c0b 100644 --- a/build/docs/FacebookPermissionEntityListing.md +++ b/build/docs/FacebookPermissionEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacebookScopedId.md b/build/docs/FacebookScopedId.md index f83cfa841..805559679 100644 --- a/build/docs/FacebookScopedId.md +++ b/build/docs/FacebookScopedId.md @@ -11,4 +11,4 @@ Scoped ID for a Facebook user interacting with a page or app -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Facet.md b/build/docs/Facet.md index a79e0d1f6..e489fa5a4 100644 --- a/build/docs/Facet.md +++ b/build/docs/Facet.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacetEntry.md b/build/docs/FacetEntry.md index 32addc110..01ac4ad6a 100644 --- a/build/docs/FacetEntry.md +++ b/build/docs/FacetEntry.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacetKeyAttribute.md b/build/docs/FacetKeyAttribute.md index 73290a147..a3ca85f5b 100644 --- a/build/docs/FacetKeyAttribute.md +++ b/build/docs/FacetKeyAttribute.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacetStatistics.md b/build/docs/FacetStatistics.md index 3ee8a70b4..a504eccc2 100644 --- a/build/docs/FacetStatistics.md +++ b/build/docs/FacetStatistics.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FacetTerm.md b/build/docs/FacetTerm.md index b7c405f7b..2d3ca73ef 100644 --- a/build/docs/FacetTerm.md +++ b/build/docs/FacetTerm.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FailedObject.md b/build/docs/FailedObject.md index c76c9f88d..7d7697916 100644 --- a/build/docs/FailedObject.md +++ b/build/docs/FailedObject.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FailedRecordingEntityListing.md b/build/docs/FailedRecordingEntityListing.md index ebc116885..590a5b864 100644 --- a/build/docs/FailedRecordingEntityListing.md +++ b/build/docs/FailedRecordingEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Fallback.md b/build/docs/Fallback.md index 73cc72d92..6717a79cc 100644 --- a/build/docs/Fallback.md +++ b/build/docs/Fallback.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Faq.md b/build/docs/Faq.md index 9b69694e6..6d0b646cf 100644 --- a/build/docs/Faq.md +++ b/build/docs/Faq.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxAPI.md b/build/docs/FaxAPI.md index 1557782a7..d7765f1db 100644 --- a/build/docs/FaxAPI.md +++ b/build/docs/FaxAPI.md @@ -403,4 +403,4 @@ FaxAPI.putFaxSettings(body: body) { (response, error) in [**FaxConfig**](FaxConfig) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxConfig.md b/build/docs/FaxConfig.md index 6eb5b6cd3..219f93a7a 100644 --- a/build/docs/FaxConfig.md +++ b/build/docs/FaxConfig.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxDocument.md b/build/docs/FaxDocument.md index bd1fd89d4..a56e7e4ad 100644 --- a/build/docs/FaxDocument.md +++ b/build/docs/FaxDocument.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxDocumentEntityListing.md b/build/docs/FaxDocumentEntityListing.md index 33d268748..42d871bbc 100644 --- a/build/docs/FaxDocumentEntityListing.md +++ b/build/docs/FaxDocumentEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxSendRequest.md b/build/docs/FaxSendRequest.md index 0ee63883b..08416d2b2 100644 --- a/build/docs/FaxSendRequest.md +++ b/build/docs/FaxSendRequest.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxSendResponse.md b/build/docs/FaxSendResponse.md index 5c5875298..ca941490c 100644 --- a/build/docs/FaxSendResponse.md +++ b/build/docs/FaxSendResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxStatus.md b/build/docs/FaxStatus.md index 18888c506..ed1ca10d5 100644 --- a/build/docs/FaxStatus.md +++ b/build/docs/FaxStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxSummary.md b/build/docs/FaxSummary.md index 257221d34..c13942c30 100644 --- a/build/docs/FaxSummary.md +++ b/build/docs/FaxSummary.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxTopicFaxDataV2.md b/build/docs/FaxTopicFaxDataV2.md index fce6b3234..7da482a49 100644 --- a/build/docs/FaxTopicFaxDataV2.md +++ b/build/docs/FaxTopicFaxDataV2.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxTopicLockData.md b/build/docs/FaxTopicLockData.md index 794f48c05..4426d1b7e 100644 --- a/build/docs/FaxTopicLockData.md +++ b/build/docs/FaxTopicLockData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxTopicUserData.md b/build/docs/FaxTopicUserData.md index b2806ddb5..70080cf4d 100644 --- a/build/docs/FaxTopicUserData.md +++ b/build/docs/FaxTopicUserData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FaxTopicWorkspaceData.md b/build/docs/FaxTopicWorkspaceData.md index f06e28a1c..c7c432315 100644 --- a/build/docs/FaxTopicWorkspaceData.md +++ b/build/docs/FaxTopicWorkspaceData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FeatureState.md b/build/docs/FeatureState.md index b1458838b..996ecfe42 100644 --- a/build/docs/FeatureState.md +++ b/build/docs/FeatureState.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Feedback.md b/build/docs/Feedback.md index 97bb038ba..6c7580560 100644 --- a/build/docs/Feedback.md +++ b/build/docs/Feedback.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FeedbackAddRequest.md b/build/docs/FeedbackAddRequest.md index 2e26a8811..1896ccd1f 100644 --- a/build/docs/FeedbackAddRequest.md +++ b/build/docs/FeedbackAddRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FieldConfig.md b/build/docs/FieldConfig.md index 40459906a..b76474b8a 100644 --- a/build/docs/FieldConfig.md +++ b/build/docs/FieldConfig.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FieldConfigs.md b/build/docs/FieldConfigs.md index 0fe5d8b07..8d32eeb04 100644 --- a/build/docs/FieldConfigs.md +++ b/build/docs/FieldConfigs.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FieldList.md b/build/docs/FieldList.md index 8e7552fbb..9dc405352 100644 --- a/build/docs/FieldList.md +++ b/build/docs/FieldList.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FileSpecificationTemplate.md b/build/docs/FileSpecificationTemplate.md index e43fd3a8f..09d2ce15e 100644 --- a/build/docs/FileSpecificationTemplate.md +++ b/build/docs/FileSpecificationTemplate.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FileSpecificationTemplateEntityListing.md b/build/docs/FileSpecificationTemplateEntityListing.md index 6f647980b..f979822a7 100644 --- a/build/docs/FileSpecificationTemplateEntityListing.md +++ b/build/docs/FileSpecificationTemplateEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FileUploadMode.md b/build/docs/FileUploadMode.md index a99a7e833..24cfd6f99 100644 --- a/build/docs/FileUploadMode.md +++ b/build/docs/FileUploadMode.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FileUploadSettings.md b/build/docs/FileUploadSettings.md index 5808da6a2..8631cf7e6 100644 --- a/build/docs/FileUploadSettings.md +++ b/build/docs/FileUploadSettings.md @@ -12,4 +12,4 @@ File upload settings for messenger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Filter.md b/build/docs/Filter.md index 1fae7b2f1..81ab3fd69 100644 --- a/build/docs/Filter.md +++ b/build/docs/Filter.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FilterPreviewResponse.md b/build/docs/FilterPreviewResponse.md index c8bb64a81..d93828878 100644 --- a/build/docs/FilterPreviewResponse.md +++ b/build/docs/FilterPreviewResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FixedAvailability.md b/build/docs/FixedAvailability.md index fc5b97c0c..0a23a0a7b 100644 --- a/build/docs/FixedAvailability.md +++ b/build/docs/FixedAvailability.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Flow.md b/build/docs/Flow.md index cd5f74a60..552a04050 100644 --- a/build/docs/Flow.md +++ b/build/docs/Flow.md @@ -33,4 +33,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityData.md b/build/docs/FlowActivityData.md index b6f134b46..2255d8a7b 100644 --- a/build/docs/FlowActivityData.md +++ b/build/docs/FlowActivityData.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityEntityData.md b/build/docs/FlowActivityEntityData.md index 67d1606b1..1ac37ba9b 100644 --- a/build/docs/FlowActivityEntityData.md +++ b/build/docs/FlowActivityEntityData.md @@ -34,4 +34,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityMetricValue.md b/build/docs/FlowActivityMetricValue.md index 9849cb960..f0774e634 100644 --- a/build/docs/FlowActivityMetricValue.md +++ b/build/docs/FlowActivityMetricValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityQuery.md b/build/docs/FlowActivityQuery.md index 52c584c2e..2368c4206 100644 --- a/build/docs/FlowActivityQuery.md +++ b/build/docs/FlowActivityQuery.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityQueryClause.md b/build/docs/FlowActivityQueryClause.md index 01446193e..4d2cf8ec8 100644 --- a/build/docs/FlowActivityQueryClause.md +++ b/build/docs/FlowActivityQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityQueryFilter.md b/build/docs/FlowActivityQueryFilter.md index 216b4c544..0b90cf961 100644 --- a/build/docs/FlowActivityQueryFilter.md +++ b/build/docs/FlowActivityQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityQueryMetric.md b/build/docs/FlowActivityQueryMetric.md index c4df3bce3..66db3329d 100644 --- a/build/docs/FlowActivityQueryMetric.md +++ b/build/docs/FlowActivityQueryMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityQueryPredicate.md b/build/docs/FlowActivityQueryPredicate.md index 2c8cc62d5..03d4a0c23 100644 --- a/build/docs/FlowActivityQueryPredicate.md +++ b/build/docs/FlowActivityQueryPredicate.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityResponse.md b/build/docs/FlowActivityResponse.md index b199a24a0..dcf52d7a4 100644 --- a/build/docs/FlowActivityResponse.md +++ b/build/docs/FlowActivityResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowActivityScoredAgent.md b/build/docs/FlowActivityScoredAgent.md index 917e6750b..870335d60 100644 --- a/build/docs/FlowActivityScoredAgent.md +++ b/build/docs/FlowActivityScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowAggregateDataContainer.md b/build/docs/FlowAggregateDataContainer.md index bb2bd14a2..c406378f6 100644 --- a/build/docs/FlowAggregateDataContainer.md +++ b/build/docs/FlowAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowAggregateQueryClause.md b/build/docs/FlowAggregateQueryClause.md index f8f35745e..39d424029 100644 --- a/build/docs/FlowAggregateQueryClause.md +++ b/build/docs/FlowAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowAggregateQueryFilter.md b/build/docs/FlowAggregateQueryFilter.md index e66e7c6c7..1c73b0202 100644 --- a/build/docs/FlowAggregateQueryFilter.md +++ b/build/docs/FlowAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowAggregateQueryPredicate.md b/build/docs/FlowAggregateQueryPredicate.md index 4fc7ec17f..ff25c077f 100644 --- a/build/docs/FlowAggregateQueryPredicate.md +++ b/build/docs/FlowAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowAggregateQueryResponse.md b/build/docs/FlowAggregateQueryResponse.md index 987860ef1..99de26abb 100644 --- a/build/docs/FlowAggregateQueryResponse.md +++ b/build/docs/FlowAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowAggregationQuery.md b/build/docs/FlowAggregationQuery.md index b4e5f64be..6e6c5eaf1 100644 --- a/build/docs/FlowAggregationQuery.md +++ b/build/docs/FlowAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowAggregationView.md b/build/docs/FlowAggregationView.md index 61b0a525a..3725a4c33 100644 --- a/build/docs/FlowAggregationView.md +++ b/build/docs/FlowAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowCharacteristics.md b/build/docs/FlowCharacteristics.md index eae8fa90d..27fd921e9 100644 --- a/build/docs/FlowCharacteristics.md +++ b/build/docs/FlowCharacteristics.md @@ -18,4 +18,4 @@ This is a set of enabled characteristics for the loglevel -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowDiagnosticInfo.md b/build/docs/FlowDiagnosticInfo.md index 9142054b6..b911e2c65 100644 --- a/build/docs/FlowDiagnosticInfo.md +++ b/build/docs/FlowDiagnosticInfo.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowDivisionView.md b/build/docs/FlowDivisionView.md index d0a1ef731..63b7a07b1 100644 --- a/build/docs/FlowDivisionView.md +++ b/build/docs/FlowDivisionView.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowDivisionViewEntityListing.md b/build/docs/FlowDivisionViewEntityListing.md index 8477378d6..103412b1b 100644 --- a/build/docs/FlowDivisionViewEntityListing.md +++ b/build/docs/FlowDivisionViewEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowEndDetailEventTopicFlowEndEvent.md b/build/docs/FlowEndDetailEventTopicFlowEndEvent.md index 3fdc3ed19..7f3f63632 100644 --- a/build/docs/FlowEndDetailEventTopicFlowEndEvent.md +++ b/build/docs/FlowEndDetailEventTopicFlowEndEvent.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowEntityListing.md b/build/docs/FlowEntityListing.md index 8a97971cb..e6fabb340 100644 --- a/build/docs/FlowEntityListing.md +++ b/build/docs/FlowEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionAggregateDataContainer.md b/build/docs/FlowExecutionAggregateDataContainer.md index 296e97395..f44f9a56c 100644 --- a/build/docs/FlowExecutionAggregateDataContainer.md +++ b/build/docs/FlowExecutionAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionAggregateQueryClause.md b/build/docs/FlowExecutionAggregateQueryClause.md index e65e98826..46ab5a4ab 100644 --- a/build/docs/FlowExecutionAggregateQueryClause.md +++ b/build/docs/FlowExecutionAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionAggregateQueryFilter.md b/build/docs/FlowExecutionAggregateQueryFilter.md index 21e4e54d7..13cd40d8b 100644 --- a/build/docs/FlowExecutionAggregateQueryFilter.md +++ b/build/docs/FlowExecutionAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionAggregateQueryPredicate.md b/build/docs/FlowExecutionAggregateQueryPredicate.md index d935eeace..d6d43bee8 100644 --- a/build/docs/FlowExecutionAggregateQueryPredicate.md +++ b/build/docs/FlowExecutionAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionAggregateQueryResponse.md b/build/docs/FlowExecutionAggregateQueryResponse.md index 54f39fe61..4c462c73e 100644 --- a/build/docs/FlowExecutionAggregateQueryResponse.md +++ b/build/docs/FlowExecutionAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionAggregationQuery.md b/build/docs/FlowExecutionAggregationQuery.md index 1c04cbfee..820a2a810 100644 --- a/build/docs/FlowExecutionAggregationQuery.md +++ b/build/docs/FlowExecutionAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionAggregationView.md b/build/docs/FlowExecutionAggregationView.md index 1aac45cce..9244af595 100644 --- a/build/docs/FlowExecutionAggregationView.md +++ b/build/docs/FlowExecutionAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionDataQueryResult.md b/build/docs/FlowExecutionDataQueryResult.md index 0e02fa89f..d01d3db68 100644 --- a/build/docs/FlowExecutionDataQueryResult.md +++ b/build/docs/FlowExecutionDataQueryResult.md @@ -23,4 +23,4 @@ This is the metadata of an executionData entry for a flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionLaunchRequest.md b/build/docs/FlowExecutionLaunchRequest.md index 700ef3bc9..14b391f0d 100644 --- a/build/docs/FlowExecutionLaunchRequest.md +++ b/build/docs/FlowExecutionLaunchRequest.md @@ -14,4 +14,4 @@ Parameters for launching a flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowExecutionLaunchResponse.md b/build/docs/FlowExecutionLaunchResponse.md index 5328a3e9b..d5e496a63 100644 --- a/build/docs/FlowExecutionLaunchResponse.md +++ b/build/docs/FlowExecutionLaunchResponse.md @@ -14,4 +14,4 @@ Response object from launching a flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowHealth.md b/build/docs/FlowHealth.md index b57411900..592f8e9b1 100644 --- a/build/docs/FlowHealth.md +++ b/build/docs/FlowHealth.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowHealthErrorInfo.md b/build/docs/FlowHealthErrorInfo.md index df1a2e3ed..faefa3098 100644 --- a/build/docs/FlowHealthErrorInfo.md +++ b/build/docs/FlowHealthErrorInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowHealthIntent.md b/build/docs/FlowHealthIntent.md index 143bc6f86..3009d1e90 100644 --- a/build/docs/FlowHealthIntent.md +++ b/build/docs/FlowHealthIntent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowHealthIntentInfo.md b/build/docs/FlowHealthIntentInfo.md index d4e2e4e01..016bf28a7 100644 --- a/build/docs/FlowHealthIntentInfo.md +++ b/build/docs/FlowHealthIntentInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowHealthIntentUtterance.md b/build/docs/FlowHealthIntentUtterance.md index 3a5091b8c..71f844c5d 100644 --- a/build/docs/FlowHealthIntentUtterance.md +++ b/build/docs/FlowHealthIntentUtterance.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowHealthIntentVersionInfo.md b/build/docs/FlowHealthIntentVersionInfo.md index aac2e5263..c8dea9f61 100644 --- a/build/docs/FlowHealthIntentVersionInfo.md +++ b/build/docs/FlowHealthIntentVersionInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowHealthUtterance.md b/build/docs/FlowHealthUtterance.md index d58f37bfb..589be4121 100644 --- a/build/docs/FlowHealthUtterance.md +++ b/build/docs/FlowHealthUtterance.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowHealthVersionInfo.md b/build/docs/FlowHealthVersionInfo.md index a8649f195..36ee08e09 100644 --- a/build/docs/FlowHealthVersionInfo.md +++ b/build/docs/FlowHealthVersionInfo.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowLogLevel.md b/build/docs/FlowLogLevel.md index ed456eb76..7c328a1b7 100644 --- a/build/docs/FlowLogLevel.md +++ b/build/docs/FlowLogLevel.md @@ -12,4 +12,4 @@ This is a table of settings per a loglevel that define what will be logged in ex -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowLogLevelCharacteristicsDefinition.md b/build/docs/FlowLogLevelCharacteristicsDefinition.md index 92ca24961..8b78c0012 100644 --- a/build/docs/FlowLogLevelCharacteristicsDefinition.md +++ b/build/docs/FlowLogLevelCharacteristicsDefinition.md @@ -13,4 +13,4 @@ Defines a characteristic that can be captured by data providers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowLogLevelCharacteristicsDefinitions.md b/build/docs/FlowLogLevelCharacteristicsDefinitions.md index 1b1bf0d76..a8aace893 100644 --- a/build/docs/FlowLogLevelCharacteristicsDefinitions.md +++ b/build/docs/FlowLogLevelCharacteristicsDefinitions.md @@ -12,4 +12,4 @@ A set of available characteristic definitions -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowLogLevelRequest.md b/build/docs/FlowLogLevelRequest.md index 53d3b19ce..568970cb1 100644 --- a/build/docs/FlowLogLevelRequest.md +++ b/build/docs/FlowLogLevelRequest.md @@ -11,4 +11,4 @@ Used to set the log level of a particular flow -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowMetricsTopicFlowMetricRecord.md b/build/docs/FlowMetricsTopicFlowMetricRecord.md index f50c8b2f6..0b97b88d1 100644 --- a/build/docs/FlowMetricsTopicFlowMetricRecord.md +++ b/build/docs/FlowMetricsTopicFlowMetricRecord.md @@ -108,4 +108,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowMetricsTopicFlowOutcome.md b/build/docs/FlowMetricsTopicFlowOutcome.md index 22586589c..e1e9f6d2b 100644 --- a/build/docs/FlowMetricsTopicFlowOutcome.md +++ b/build/docs/FlowMetricsTopicFlowOutcome.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowMetricsTopicFlowProposedAgent.md b/build/docs/FlowMetricsTopicFlowProposedAgent.md index e098f5611..9a63e4298 100644 --- a/build/docs/FlowMetricsTopicFlowProposedAgent.md +++ b/build/docs/FlowMetricsTopicFlowProposedAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowMetricsTopicFlowScoredAgent.md b/build/docs/FlowMetricsTopicFlowScoredAgent.md index afbe8d033..9c4ca972e 100644 --- a/build/docs/FlowMetricsTopicFlowScoredAgent.md +++ b/build/docs/FlowMetricsTopicFlowScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowMilestone.md b/build/docs/FlowMilestone.md index 14ef19d9c..b57e88332 100644 --- a/build/docs/FlowMilestone.md +++ b/build/docs/FlowMilestone.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowMilestoneDivisionView.md b/build/docs/FlowMilestoneDivisionView.md index e62f0c79e..66e5d16fd 100644 --- a/build/docs/FlowMilestoneDivisionView.md +++ b/build/docs/FlowMilestoneDivisionView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowMilestoneDivisionViewEntityListing.md b/build/docs/FlowMilestoneDivisionViewEntityListing.md index e537f0c2f..c033c760e 100644 --- a/build/docs/FlowMilestoneDivisionViewEntityListing.md +++ b/build/docs/FlowMilestoneDivisionViewEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowMilestoneListing.md b/build/docs/FlowMilestoneListing.md index 064b42ea8..68149e930 100644 --- a/build/docs/FlowMilestoneListing.md +++ b/build/docs/FlowMilestoneListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowObservationDataContainer.md b/build/docs/FlowObservationDataContainer.md index eecf0af36..d105ae6a7 100644 --- a/build/docs/FlowObservationDataContainer.md +++ b/build/docs/FlowObservationDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowObservationQuery.md b/build/docs/FlowObservationQuery.md index 2774929b5..21fd3b1f5 100644 --- a/build/docs/FlowObservationQuery.md +++ b/build/docs/FlowObservationQuery.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowObservationQueryClause.md b/build/docs/FlowObservationQueryClause.md index 60182e22e..ce8a749e2 100644 --- a/build/docs/FlowObservationQueryClause.md +++ b/build/docs/FlowObservationQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowObservationQueryFilter.md b/build/docs/FlowObservationQueryFilter.md index f4fb0e791..6e50f73ca 100644 --- a/build/docs/FlowObservationQueryFilter.md +++ b/build/docs/FlowObservationQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowObservationQueryPredicate.md b/build/docs/FlowObservationQueryPredicate.md index f66ee66f0..8b39cea00 100644 --- a/build/docs/FlowObservationQueryPredicate.md +++ b/build/docs/FlowObservationQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowObservationQueryResponse.md b/build/docs/FlowObservationQueryResponse.md index aabe7e6b8..7e599eb79 100644 --- a/build/docs/FlowObservationQueryResponse.md +++ b/build/docs/FlowObservationQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowOutcome.md b/build/docs/FlowOutcome.md index fc8044aeb..1e907c7e3 100644 --- a/build/docs/FlowOutcome.md +++ b/build/docs/FlowOutcome.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowOutcomeDetailEventTopicFlowMilestone.md b/build/docs/FlowOutcomeDetailEventTopicFlowMilestone.md index 51666bda8..95abf4612 100644 --- a/build/docs/FlowOutcomeDetailEventTopicFlowMilestone.md +++ b/build/docs/FlowOutcomeDetailEventTopicFlowMilestone.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowOutcomeDetailEventTopicFlowOutcomeEvent.md b/build/docs/FlowOutcomeDetailEventTopicFlowOutcomeEvent.md index 860c8a5cd..a3f25ab46 100644 --- a/build/docs/FlowOutcomeDetailEventTopicFlowOutcomeEvent.md +++ b/build/docs/FlowOutcomeDetailEventTopicFlowOutcomeEvent.md @@ -33,4 +33,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowOutcomeDivisionView.md b/build/docs/FlowOutcomeDivisionView.md index 940acff22..545116ed1 100644 --- a/build/docs/FlowOutcomeDivisionView.md +++ b/build/docs/FlowOutcomeDivisionView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowOutcomeDivisionViewEntityListing.md b/build/docs/FlowOutcomeDivisionViewEntityListing.md index aa26dceae..e2278f87f 100644 --- a/build/docs/FlowOutcomeDivisionViewEntityListing.md +++ b/build/docs/FlowOutcomeDivisionViewEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowOutcomeListing.md b/build/docs/FlowOutcomeListing.md index 05041299b..58e97de63 100644 --- a/build/docs/FlowOutcomeListing.md +++ b/build/docs/FlowOutcomeListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowPaths.md b/build/docs/FlowPaths.md index daaadec8f..5e29a732d 100644 --- a/build/docs/FlowPaths.md +++ b/build/docs/FlowPaths.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowPathsElement.md b/build/docs/FlowPathsElement.md index 3ab620ed8..64345c54f 100644 --- a/build/docs/FlowPathsElement.md +++ b/build/docs/FlowPathsElement.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowPathsFlowDetails.md b/build/docs/FlowPathsFlowDetails.md index a02f07775..b2d11159d 100644 --- a/build/docs/FlowPathsFlowDetails.md +++ b/build/docs/FlowPathsFlowDetails.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowPathsFlowFilter.md b/build/docs/FlowPathsFlowFilter.md index de6be8a74..46c5cc554 100644 --- a/build/docs/FlowPathsFlowFilter.md +++ b/build/docs/FlowPathsFlowFilter.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowPathsQuery.md b/build/docs/FlowPathsQuery.md index 730768b9d..ba4b9b830 100644 --- a/build/docs/FlowPathsQuery.md +++ b/build/docs/FlowPathsQuery.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowResultEntityListing.md b/build/docs/FlowResultEntityListing.md index f5a8d0cdc..8e16d034f 100644 --- a/build/docs/FlowResultEntityListing.md +++ b/build/docs/FlowResultEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowRuntimeExecution.md b/build/docs/FlowRuntimeExecution.md index 9ca0de2bb..d6c5038e1 100644 --- a/build/docs/FlowRuntimeExecution.md +++ b/build/docs/FlowRuntimeExecution.md @@ -21,4 +21,4 @@ Details about the current state of a Flow execution -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowSettingsResponse.md b/build/docs/FlowSettingsResponse.md index f7f52f9fc..5999f82dd 100644 --- a/build/docs/FlowSettingsResponse.md +++ b/build/docs/FlowSettingsResponse.md @@ -18,4 +18,4 @@ This is a table of settings per a loglevel that define what will be logged in ex -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowSettingsResponseEntityListing.md b/build/docs/FlowSettingsResponseEntityListing.md index c35ea71e7..168e8dbc6 100644 --- a/build/docs/FlowSettingsResponseEntityListing.md +++ b/build/docs/FlowSettingsResponseEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowStartDetailEventTopicFlowStartEvent.md b/build/docs/FlowStartDetailEventTopicFlowStartEvent.md index 3e75d4e81..ca0fb68cd 100644 --- a/build/docs/FlowStartDetailEventTopicFlowStartEvent.md +++ b/build/docs/FlowStartDetailEventTopicFlowStartEvent.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowVersion.md b/build/docs/FlowVersion.md index 366e600fa..6adea8085 100644 --- a/build/docs/FlowVersion.md +++ b/build/docs/FlowVersion.md @@ -33,4 +33,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowVersionEntityListing.md b/build/docs/FlowVersionEntityListing.md index c44fa44f5..2e5653a97 100644 --- a/build/docs/FlowVersionEntityListing.md +++ b/build/docs/FlowVersionEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowsAPI.md b/build/docs/FlowsAPI.md index 0df70bd35..694fbbaab 100644 --- a/build/docs/FlowsAPI.md +++ b/build/docs/FlowsAPI.md @@ -164,4 +164,4 @@ FlowsAPI.postAnalyticsFlowsObservationsQuery(body: body) { (response, error) in [**FlowObservationQueryResponse**](FlowObservationQueryResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FlowsQueryCriteriaResponse.md b/build/docs/FlowsQueryCriteriaResponse.md index a3e4a27d8..a23c4b630 100644 --- a/build/docs/FlowsQueryCriteriaResponse.md +++ b/build/docs/FlowsQueryCriteriaResponse.md @@ -15,4 +15,4 @@ The response for QueryCapabilities which contains the allowed criteria, flow typ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FooterTemplate.md b/build/docs/FooterTemplate.md index 95bbbf3a3..dc459bdb0 100644 --- a/build/docs/FooterTemplate.md +++ b/build/docs/FooterTemplate.md @@ -12,4 +12,4 @@ The Footer template identifies the Footer type and its footerUsage -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastAbandonRateResponse.md b/build/docs/ForecastAbandonRateResponse.md index ff5455c65..71dd77c50 100644 --- a/build/docs/ForecastAbandonRateResponse.md +++ b/build/docs/ForecastAbandonRateResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastAverageSpeedOfAnswerResponse.md b/build/docs/ForecastAverageSpeedOfAnswerResponse.md index 07104ee79..d87275fa7 100644 --- a/build/docs/ForecastAverageSpeedOfAnswerResponse.md +++ b/build/docs/ForecastAverageSpeedOfAnswerResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastPlanningGroupData.md b/build/docs/ForecastPlanningGroupData.md index 4738f0c01..768e29c28 100644 --- a/build/docs/ForecastPlanningGroupData.md +++ b/build/docs/ForecastPlanningGroupData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastPlanningGroupResponse.md b/build/docs/ForecastPlanningGroupResponse.md index 88d75db69..a0ec6e1a9 100644 --- a/build/docs/ForecastPlanningGroupResponse.md +++ b/build/docs/ForecastPlanningGroupResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastPlanningGroupsResponse.md b/build/docs/ForecastPlanningGroupsResponse.md index 9109fe95d..f189643c7 100644 --- a/build/docs/ForecastPlanningGroupsResponse.md +++ b/build/docs/ForecastPlanningGroupsResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastServiceGoalTemplateImpactOverrideResponse.md b/build/docs/ForecastServiceGoalTemplateImpactOverrideResponse.md index 5d5067797..b05c2acb3 100644 --- a/build/docs/ForecastServiceGoalTemplateImpactOverrideResponse.md +++ b/build/docs/ForecastServiceGoalTemplateImpactOverrideResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastServiceGoalTemplateResponse.md b/build/docs/ForecastServiceGoalTemplateResponse.md index 1f85e76f5..d6f5eec04 100644 --- a/build/docs/ForecastServiceGoalTemplateResponse.md +++ b/build/docs/ForecastServiceGoalTemplateResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastServiceLevelResponse.md b/build/docs/ForecastServiceLevelResponse.md index 52af09a63..a9ca99931 100644 --- a/build/docs/ForecastServiceLevelResponse.md +++ b/build/docs/ForecastServiceLevelResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ForecastSourceDayPointer.md b/build/docs/ForecastSourceDayPointer.md index 52911cc9e..da1c0194c 100644 --- a/build/docs/ForecastSourceDayPointer.md +++ b/build/docs/ForecastSourceDayPointer.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Format.md b/build/docs/Format.md index a6825e717..1df791efe 100644 --- a/build/docs/Format.md +++ b/build/docs/Format.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FormsTrackTrigger.md b/build/docs/FormsTrackTrigger.md index af4fb06d6..6d690cafe 100644 --- a/build/docs/FormsTrackTrigger.md +++ b/build/docs/FormsTrackTrigger.md @@ -14,4 +14,4 @@ Details about a forms tracking event trigger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FreeTrialLimit.md b/build/docs/FreeTrialLimit.md index 2b44b16e7..f0a388cbe 100644 --- a/build/docs/FreeTrialLimit.md +++ b/build/docs/FreeTrialLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FreeTrialLimitDocs.md b/build/docs/FreeTrialLimitDocs.md index a02528ae6..4b9074977 100644 --- a/build/docs/FreeTrialLimitDocs.md +++ b/build/docs/FreeTrialLimitDocs.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FreeTrialNamespace.md b/build/docs/FreeTrialNamespace.md index a511a1be9..0f9f2d163 100644 --- a/build/docs/FreeTrialNamespace.md +++ b/build/docs/FreeTrialNamespace.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FromEmailAddress.md b/build/docs/FromEmailAddress.md index 9eda28b65..de5cf987c 100644 --- a/build/docs/FromEmailAddress.md +++ b/build/docs/FromEmailAddress.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/FullDayTimeOffMarker.md b/build/docs/FullDayTimeOffMarker.md index a315c7fc4..f539c3de9 100644 --- a/build/docs/FullDayTimeOffMarker.md +++ b/build/docs/FullDayTimeOffMarker.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GDPRJourneyCustomer.md b/build/docs/GDPRJourneyCustomer.md index 444ca34a4..b0d035fc2 100644 --- a/build/docs/GDPRJourneyCustomer.md +++ b/build/docs/GDPRJourneyCustomer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GDPRRequest.md b/build/docs/GDPRRequest.md index 08171397c..aa5973f0f 100644 --- a/build/docs/GDPRRequest.md +++ b/build/docs/GDPRRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GDPRRequestEntityListing.md b/build/docs/GDPRRequestEntityListing.md index a0e420d25..397962d15 100644 --- a/build/docs/GDPRRequestEntityListing.md +++ b/build/docs/GDPRRequestEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GDPRSubject.md b/build/docs/GDPRSubject.md index 0b4486319..6d2e286b5 100644 --- a/build/docs/GDPRSubject.md +++ b/build/docs/GDPRSubject.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GDPRSubjectEntityListing.md b/build/docs/GDPRSubjectEntityListing.md index a96f2e335..cbce2925b 100644 --- a/build/docs/GDPRSubjectEntityListing.md +++ b/build/docs/GDPRSubjectEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GKNDocumentationResult.md b/build/docs/GKNDocumentationResult.md index 096ce9a7e..1214c6b02 100644 --- a/build/docs/GKNDocumentationResult.md +++ b/build/docs/GKNDocumentationResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GKNDocumentationSearchCriteria.md b/build/docs/GKNDocumentationSearchCriteria.md index b32b136bd..05c710fbd 100644 --- a/build/docs/GKNDocumentationSearchCriteria.md +++ b/build/docs/GKNDocumentationSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GKNDocumentationSearchRequest.md b/build/docs/GKNDocumentationSearchRequest.md index 310badfc0..3f30eef68 100644 --- a/build/docs/GKNDocumentationSearchRequest.md +++ b/build/docs/GKNDocumentationSearchRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GKNDocumentationSearchResponse.md b/build/docs/GKNDocumentationSearchResponse.md index f4b7b2902..5d00a3f4e 100644 --- a/build/docs/GKNDocumentationSearchResponse.md +++ b/build/docs/GKNDocumentationSearchResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GSuite.md b/build/docs/GSuite.md index dbe91876c..58e900647 100644 --- a/build/docs/GSuite.md +++ b/build/docs/GSuite.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GamificationAPI.md b/build/docs/GamificationAPI.md index d5e41f0f8..f1d0a2bc4 100644 --- a/build/docs/GamificationAPI.md +++ b/build/docs/GamificationAPI.md @@ -3451,4 +3451,4 @@ GamificationAPI.putGamificationStatus(status: status) { (response, error) in [**GamificationStatus**](GamificationStatus) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GamificationScorecardChangeTopicEvaluationDetail.md b/build/docs/GamificationScorecardChangeTopicEvaluationDetail.md index c9a624f5d..4692646e6 100644 --- a/build/docs/GamificationScorecardChangeTopicEvaluationDetail.md +++ b/build/docs/GamificationScorecardChangeTopicEvaluationDetail.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GamificationScorecardChangeTopicMetric.md b/build/docs/GamificationScorecardChangeTopicMetric.md index 6afc965e3..086bba93d 100644 --- a/build/docs/GamificationScorecardChangeTopicMetric.md +++ b/build/docs/GamificationScorecardChangeTopicMetric.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GamificationScorecardChangeTopicPerformanceMetric.md b/build/docs/GamificationScorecardChangeTopicPerformanceMetric.md index 9c3b484a8..d83e20e77 100644 --- a/build/docs/GamificationScorecardChangeTopicPerformanceMetric.md +++ b/build/docs/GamificationScorecardChangeTopicPerformanceMetric.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GamificationScorecardChangeTopicPunctualityEvent.md b/build/docs/GamificationScorecardChangeTopicPunctualityEvent.md index 3d68b86fa..bcc6343c2 100644 --- a/build/docs/GamificationScorecardChangeTopicPunctualityEvent.md +++ b/build/docs/GamificationScorecardChangeTopicPunctualityEvent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GamificationScorecardChangeTopicScorecardChange.md b/build/docs/GamificationScorecardChangeTopicScorecardChange.md index 1ead93987..dc228b0a5 100644 --- a/build/docs/GamificationScorecardChangeTopicScorecardChange.md +++ b/build/docs/GamificationScorecardChangeTopicScorecardChange.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GamificationStatus.md b/build/docs/GamificationStatus.md index 88419386d..4c0bf43d7 100644 --- a/build/docs/GamificationStatus.md +++ b/build/docs/GamificationStatus.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GeneralDataProtectionRegulationAPI.md b/build/docs/GeneralDataProtectionRegulationAPI.md index b415f4751..864c2690d 100644 --- a/build/docs/GeneralDataProtectionRegulationAPI.md +++ b/build/docs/GeneralDataProtectionRegulationAPI.md @@ -217,4 +217,4 @@ GeneralDataProtectionRegulationAPI.postGdprRequests(body: body, deleteConfirmed: [**GDPRRequest**](GDPRRequest) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GeneralProgramJob.md b/build/docs/GeneralProgramJob.md index 9e01d3753..c1e3da84b 100644 --- a/build/docs/GeneralProgramJob.md +++ b/build/docs/GeneralProgramJob.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GeneralProgramJobRequest.md b/build/docs/GeneralProgramJobRequest.md index 62d2a995d..4e21ca700 100644 --- a/build/docs/GeneralProgramJobRequest.md +++ b/build/docs/GeneralProgramJobRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GeneralTopic.md b/build/docs/GeneralTopic.md index 33560326b..fd082fb48 100644 --- a/build/docs/GeneralTopic.md +++ b/build/docs/GeneralTopic.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GeneralTopicsEntityListing.md b/build/docs/GeneralTopicsEntityListing.md index 7f5b0cb29..10fe277ea 100644 --- a/build/docs/GeneralTopicsEntityListing.md +++ b/build/docs/GeneralTopicsEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GenerateBuForecastRequest.md b/build/docs/GenerateBuForecastRequest.md index 41de67011..fa2054c75 100644 --- a/build/docs/GenerateBuForecastRequest.md +++ b/build/docs/GenerateBuForecastRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GenericSAML.md b/build/docs/GenericSAML.md index 11b65db99..52ab82005 100644 --- a/build/docs/GenericSAML.md +++ b/build/docs/GenericSAML.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GenericTemplate.md b/build/docs/GenericTemplate.md index 9a956aa60..76c7b138f 100644 --- a/build/docs/GenericTemplate.md +++ b/build/docs/GenericTemplate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GenesysBotConnector.md b/build/docs/GenesysBotConnector.md index 14aaf5417..588218b92 100644 --- a/build/docs/GenesysBotConnector.md +++ b/build/docs/GenesysBotConnector.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Geolocation.md b/build/docs/Geolocation.md index 50ac26640..f104b73c5 100644 --- a/build/docs/Geolocation.md +++ b/build/docs/Geolocation.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GeolocationAPI.md b/build/docs/GeolocationAPI.md index efb9f802e..ccfd57e06 100644 --- a/build/docs/GeolocationAPI.md +++ b/build/docs/GeolocationAPI.md @@ -212,4 +212,4 @@ GeolocationAPI.patchUserGeolocation(userId: userId, clientId: clientId, body: bo [**Geolocation**](Geolocation) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GeolocationEventGeolocation.md b/build/docs/GeolocationEventGeolocation.md index 62781d4b9..4ba8fd1e4 100644 --- a/build/docs/GeolocationEventGeolocation.md +++ b/build/docs/GeolocationEventGeolocation.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GeolocationSettings.md b/build/docs/GeolocationSettings.md index 66e3e8db1..ebb8d070f 100644 --- a/build/docs/GeolocationSettings.md +++ b/build/docs/GeolocationSettings.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetAgentsWorkPlansRequest.md b/build/docs/GetAgentsWorkPlansRequest.md index 7d07bc2eb..4e1c05019 100644 --- a/build/docs/GetAgentsWorkPlansRequest.md +++ b/build/docs/GetAgentsWorkPlansRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetAlertQuery.md b/build/docs/GetAlertQuery.md index e2da55cc7..90aae2e3e 100644 --- a/build/docs/GetAlertQuery.md +++ b/build/docs/GetAlertQuery.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetCelebrationListing.md b/build/docs/GetCelebrationListing.md index f1f110a96..3002e4ea9 100644 --- a/build/docs/GetCelebrationListing.md +++ b/build/docs/GetCelebrationListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetFlowExecutionDataJobResult.md b/build/docs/GetFlowExecutionDataJobResult.md index c9cba0632..bab55aebd 100644 --- a/build/docs/GetFlowExecutionDataJobResult.md +++ b/build/docs/GetFlowExecutionDataJobResult.md @@ -15,4 +15,4 @@ This is a list of executionData links that can be used to download the complete -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetMetricDefinitionsResponse.md b/build/docs/GetMetricDefinitionsResponse.md index 30e53520b..2061addeb 100644 --- a/build/docs/GetMetricDefinitionsResponse.md +++ b/build/docs/GetMetricDefinitionsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetMetricResponse.md b/build/docs/GetMetricResponse.md index 347f2d786..c6684b154 100644 --- a/build/docs/GetMetricResponse.md +++ b/build/docs/GetMetricResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetMetricsResponse.md b/build/docs/GetMetricsResponse.md index b113eab34..0025ef5bf 100644 --- a/build/docs/GetMetricsResponse.md +++ b/build/docs/GetMetricsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetProfilesResponse.md b/build/docs/GetProfilesResponse.md index 5eadd80a2..7e61f2944 100644 --- a/build/docs/GetProfilesResponse.md +++ b/build/docs/GetProfilesResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetRulesQuery.md b/build/docs/GetRulesQuery.md index b5c364b5a..3f8427e0b 100644 --- a/build/docs/GetRulesQuery.md +++ b/build/docs/GetRulesQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GetTemplatesResponse.md b/build/docs/GetTemplatesResponse.md index 8b16b55f3..25d97ee80 100644 --- a/build/docs/GetTemplatesResponse.md +++ b/build/docs/GetTemplatesResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GoogleDialogflowConfig.md b/build/docs/GoogleDialogflowConfig.md index f1851755e..5809b60b6 100644 --- a/build/docs/GoogleDialogflowConfig.md +++ b/build/docs/GoogleDialogflowConfig.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GoogleDialogflowCustomSettings.md b/build/docs/GoogleDialogflowCustomSettings.md index fcc31c45f..15b665e32 100644 --- a/build/docs/GoogleDialogflowCustomSettings.md +++ b/build/docs/GoogleDialogflowCustomSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Grammar.md b/build/docs/Grammar.md index cba7793ed..400b49a1b 100644 --- a/build/docs/Grammar.md +++ b/build/docs/Grammar.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GrammarFileUploadRequest.md b/build/docs/GrammarFileUploadRequest.md index 0a0cb3c7a..42bb45058 100644 --- a/build/docs/GrammarFileUploadRequest.md +++ b/build/docs/GrammarFileUploadRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GrammarLanguage.md b/build/docs/GrammarLanguage.md index dddde5035..ea2471424 100644 --- a/build/docs/GrammarLanguage.md +++ b/build/docs/GrammarLanguage.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GrammarLanguageFileMetadata.md b/build/docs/GrammarLanguageFileMetadata.md index d418cd163..755d20b70 100644 --- a/build/docs/GrammarLanguageFileMetadata.md +++ b/build/docs/GrammarLanguageFileMetadata.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GrammarLanguageUpdate.md b/build/docs/GrammarLanguageUpdate.md index 5620c7ca9..851f7c232 100644 --- a/build/docs/GrammarLanguageUpdate.md +++ b/build/docs/GrammarLanguageUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GrammarListing.md b/build/docs/GrammarListing.md index 360fd53b1..70d788fc6 100644 --- a/build/docs/GrammarListing.md +++ b/build/docs/GrammarListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GraphApiSettings.md b/build/docs/GraphApiSettings.md index eaad35ea8..2c694a6ac 100644 --- a/build/docs/GraphApiSettings.md +++ b/build/docs/GraphApiSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Greeting.md b/build/docs/Greeting.md index e22c26ece..c332376ab 100644 --- a/build/docs/Greeting.md +++ b/build/docs/Greeting.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GreetingAudioFile.md b/build/docs/GreetingAudioFile.md index 578bf39d4..95b3a5d20 100644 --- a/build/docs/GreetingAudioFile.md +++ b/build/docs/GreetingAudioFile.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GreetingListing.md b/build/docs/GreetingListing.md index 914dfca0a..09c13ab5c 100644 --- a/build/docs/GreetingListing.md +++ b/build/docs/GreetingListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GreetingMediaInfo.md b/build/docs/GreetingMediaInfo.md index db1f1d74b..97f0cc8a8 100644 --- a/build/docs/GreetingMediaInfo.md +++ b/build/docs/GreetingMediaInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GreetingOwner.md b/build/docs/GreetingOwner.md index 86e676a29..9e65d1011 100644 --- a/build/docs/GreetingOwner.md +++ b/build/docs/GreetingOwner.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GreetingsAPI.md b/build/docs/GreetingsAPI.md index b042abf52..5a60c9734 100644 --- a/build/docs/GreetingsAPI.md +++ b/build/docs/GreetingsAPI.md @@ -824,4 +824,4 @@ GreetingsAPI.putUserGreetingsDefaults(userId: userId, body: body) { (response, e [**DefaultGreetingList**](DefaultGreetingList) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Group.md b/build/docs/Group.md index 244e68415..48b0bc0e1 100644 --- a/build/docs/Group.md +++ b/build/docs/Group.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupByAttribute.md b/build/docs/GroupByAttribute.md index 321652a84..b2baebaae 100644 --- a/build/docs/GroupByAttribute.md +++ b/build/docs/GroupByAttribute.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupContact.md b/build/docs/GroupContact.md index 54ccd50a2..04933df98 100644 --- a/build/docs/GroupContact.md +++ b/build/docs/GroupContact.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupCreate.md b/build/docs/GroupCreate.md index 316f74fd5..39400f8f2 100644 --- a/build/docs/GroupCreate.md +++ b/build/docs/GroupCreate.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupEntityListing.md b/build/docs/GroupEntityListing.md index 0995842d1..52e3dd820 100644 --- a/build/docs/GroupEntityListing.md +++ b/build/docs/GroupEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupGreetingEventGreeting.md b/build/docs/GroupGreetingEventGreeting.md index 8392373d4..11ffa16c4 100644 --- a/build/docs/GroupGreetingEventGreeting.md +++ b/build/docs/GroupGreetingEventGreeting.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupGreetingEventGreetingAudioFile.md b/build/docs/GroupGreetingEventGreetingAudioFile.md index 7acc1c9ea..1c6c8c67c 100644 --- a/build/docs/GroupGreetingEventGreetingAudioFile.md +++ b/build/docs/GroupGreetingEventGreetingAudioFile.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupGreetingEventGreetingOwner.md b/build/docs/GroupGreetingEventGreetingOwner.md index 38eb1c9da..3518a5a5e 100644 --- a/build/docs/GroupGreetingEventGreetingOwner.md +++ b/build/docs/GroupGreetingEventGreetingOwner.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupMembersUpdate.md b/build/docs/GroupMembersUpdate.md index c6d58ddb4..f26aec4c8 100644 --- a/build/docs/GroupMembersUpdate.md +++ b/build/docs/GroupMembersUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupProfile.md b/build/docs/GroupProfile.md index a64fe83c8..b4d187ea5 100644 --- a/build/docs/GroupProfile.md +++ b/build/docs/GroupProfile.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupProfileEntityListing.md b/build/docs/GroupProfileEntityListing.md index 162f13b98..15dfc360c 100644 --- a/build/docs/GroupProfileEntityListing.md +++ b/build/docs/GroupProfileEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupSearchCriteria.md b/build/docs/GroupSearchCriteria.md index 7b6287292..36c1a264e 100644 --- a/build/docs/GroupSearchCriteria.md +++ b/build/docs/GroupSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupSearchRequest.md b/build/docs/GroupSearchRequest.md index 0d1480b43..da9d57966 100644 --- a/build/docs/GroupSearchRequest.md +++ b/build/docs/GroupSearchRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupSettings.md b/build/docs/GroupSettings.md index 8368b7c29..a0ec4ee6e 100644 --- a/build/docs/GroupSettings.md +++ b/build/docs/GroupSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupUpdate.md b/build/docs/GroupUpdate.md index 85d5c1278..d45f45858 100644 --- a/build/docs/GroupUpdate.md +++ b/build/docs/GroupUpdate.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupsAPI.md b/build/docs/GroupsAPI.md index 1a318d756..c3d4600fc 100644 --- a/build/docs/GroupsAPI.md +++ b/build/docs/GroupsAPI.md @@ -747,4 +747,4 @@ GroupsAPI.putGroup(groupId: groupId, body: body) { (response, error) in [**Group**](Group) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GroupsSearchResponse.md b/build/docs/GroupsSearchResponse.md index 6474f22ec..cfdaba48a 100644 --- a/build/docs/GroupsSearchResponse.md +++ b/build/docs/GroupsSearchResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GuestCategoryReference.md b/build/docs/GuestCategoryReference.md index 1c3e85fb3..5cac8682a 100644 --- a/build/docs/GuestCategoryReference.md +++ b/build/docs/GuestCategoryReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GuestCategoryResponseListing.md b/build/docs/GuestCategoryResponseListing.md index 41e4904b8..4ba5a6d57 100644 --- a/build/docs/GuestCategoryResponseListing.md +++ b/build/docs/GuestCategoryResponseListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GuestMemberInfo.md b/build/docs/GuestMemberInfo.md index 487a2dbeb..45070a8ac 100644 --- a/build/docs/GuestMemberInfo.md +++ b/build/docs/GuestMemberInfo.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/GuestResponseCategory.md b/build/docs/GuestResponseCategory.md index 311f5da94..b2ce60893 100644 --- a/build/docs/GuestResponseCategory.md +++ b/build/docs/GuestResponseCategory.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HeadcountForecast.md b/build/docs/HeadcountForecast.md index a5789c2d7..57f301064 100644 --- a/build/docs/HeadcountForecast.md +++ b/build/docs/HeadcountForecast.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HeadcountInterval.md b/build/docs/HeadcountInterval.md index 1ec179b73..26db4ddf3 100644 --- a/build/docs/HeadcountInterval.md +++ b/build/docs/HeadcountInterval.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Header.md b/build/docs/Header.md index e8e46612f..45ac8cc6e 100644 --- a/build/docs/Header.md +++ b/build/docs/Header.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HealthInfo.md b/build/docs/HealthInfo.md index 7ab62d8b8..49fd64b29 100644 --- a/build/docs/HealthInfo.md +++ b/build/docs/HealthInfo.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HelpLink.md b/build/docs/HelpLink.md index 79240a653..c6d1b7377 100644 --- a/build/docs/HelpLink.md +++ b/build/docs/HelpLink.md @@ -13,4 +13,4 @@ Link to a help or support resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HelpSettings.md b/build/docs/HelpSettings.md index b8ee64e53..6018287fd 100644 --- a/build/docs/HelpSettings.md +++ b/build/docs/HelpSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalAdherenceActuals.md b/build/docs/HistoricalAdherenceActuals.md index 054607302..442006af8 100644 --- a/build/docs/HistoricalAdherenceActuals.md +++ b/build/docs/HistoricalAdherenceActuals.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalAdherenceDayMetrics.md b/build/docs/HistoricalAdherenceDayMetrics.md index e1a495b43..622767a1e 100644 --- a/build/docs/HistoricalAdherenceDayMetrics.md +++ b/build/docs/HistoricalAdherenceDayMetrics.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalAdherenceExceptionInfo.md b/build/docs/HistoricalAdherenceExceptionInfo.md index 01a4d1d8c..a73ae08d9 100644 --- a/build/docs/HistoricalAdherenceExceptionInfo.md +++ b/build/docs/HistoricalAdherenceExceptionInfo.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalAdherenceQueryResult.md b/build/docs/HistoricalAdherenceQueryResult.md index d3007f4a2..a1fed7f5a 100644 --- a/build/docs/HistoricalAdherenceQueryResult.md +++ b/build/docs/HistoricalAdherenceQueryResult.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalImportDeleteJobResponse.md b/build/docs/HistoricalImportDeleteJobResponse.md index 9c243c25e..fa89a3899 100644 --- a/build/docs/HistoricalImportDeleteJobResponse.md +++ b/build/docs/HistoricalImportDeleteJobResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalImportStatus.md b/build/docs/HistoricalImportStatus.md index 571385855..c0c4a0dd0 100644 --- a/build/docs/HistoricalImportStatus.md +++ b/build/docs/HistoricalImportStatus.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalImportStatusListing.md b/build/docs/HistoricalImportStatusListing.md index f7327f4c4..0dcdf3da3 100644 --- a/build/docs/HistoricalImportStatusListing.md +++ b/build/docs/HistoricalImportStatusListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalShrinkageActivityCategoryResponse.md b/build/docs/HistoricalShrinkageActivityCategoryResponse.md index d3956b69a..f1ff21c1c 100644 --- a/build/docs/HistoricalShrinkageActivityCategoryResponse.md +++ b/build/docs/HistoricalShrinkageActivityCategoryResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalShrinkageActivityCodeResponse.md b/build/docs/HistoricalShrinkageActivityCodeResponse.md index 3e6b04230..9f9250cb8 100644 --- a/build/docs/HistoricalShrinkageActivityCodeResponse.md +++ b/build/docs/HistoricalShrinkageActivityCodeResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalShrinkageAggregateResponse.md b/build/docs/HistoricalShrinkageAggregateResponse.md index 22ca81bb6..82d1c325e 100644 --- a/build/docs/HistoricalShrinkageAggregateResponse.md +++ b/build/docs/HistoricalShrinkageAggregateResponse.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalShrinkageResult.md b/build/docs/HistoricalShrinkageResult.md index 87cf909c2..320f3a05a 100644 --- a/build/docs/HistoricalShrinkageResult.md +++ b/build/docs/HistoricalShrinkageResult.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoricalShrinkageResultListing.md b/build/docs/HistoricalShrinkageResultListing.md index 0104a7324..395e31bed 100644 --- a/build/docs/HistoricalShrinkageResultListing.md +++ b/build/docs/HistoricalShrinkageResultListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoryEntry.md b/build/docs/HistoryEntry.md index ed0f4c293..d7902036b 100644 --- a/build/docs/HistoryEntry.md +++ b/build/docs/HistoryEntry.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoryHeadersTranslation.md b/build/docs/HistoryHeadersTranslation.md index 950ad691e..3f2c45a5e 100644 --- a/build/docs/HistoryHeadersTranslation.md +++ b/build/docs/HistoryHeadersTranslation.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HistoryListing.md b/build/docs/HistoryListing.md index 858f86489..5e9f07842 100644 --- a/build/docs/HistoryListing.md +++ b/build/docs/HistoryListing.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HoldUpdatedEvent.md b/build/docs/HoldUpdatedEvent.md index 94e7010a8..a768387f8 100644 --- a/build/docs/HoldUpdatedEvent.md +++ b/build/docs/HoldUpdatedEvent.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HomerRecord.md b/build/docs/HomerRecord.md index 2692eb062..c1e824c00 100644 --- a/build/docs/HomerRecord.md +++ b/build/docs/HomerRecord.md @@ -60,4 +60,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HrisTimeOffType.md b/build/docs/HrisTimeOffType.md index fe1069760..ddfa8d0cc 100644 --- a/build/docs/HrisTimeOffType.md +++ b/build/docs/HrisTimeOffType.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HrisTimeOffTypeResponse.md b/build/docs/HrisTimeOffTypeResponse.md index 96c54bc0e..dfe6b4d3d 100644 --- a/build/docs/HrisTimeOffTypeResponse.md +++ b/build/docs/HrisTimeOffTypeResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HrisTimeOffTypesJobReference.md b/build/docs/HrisTimeOffTypesJobReference.md index 88c5eaac2..d369fc51f 100644 --- a/build/docs/HrisTimeOffTypesJobReference.md +++ b/build/docs/HrisTimeOffTypesJobReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HrisTimeOffTypesJobResponse.md b/build/docs/HrisTimeOffTypesJobResponse.md index 40292c30b..a31233c13 100644 --- a/build/docs/HrisTimeOffTypesJobResponse.md +++ b/build/docs/HrisTimeOffTypesJobResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/HrisTimeOffTypesResponse.md b/build/docs/HrisTimeOffTypesResponse.md index d4ab0d517..d54ad5d49 100644 --- a/build/docs/HrisTimeOffTypesResponse.md +++ b/build/docs/HrisTimeOffTypesResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Humanize.md b/build/docs/Humanize.md index 7216a34e5..1c137242c 100644 --- a/build/docs/Humanize.md +++ b/build/docs/Humanize.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IVR.md b/build/docs/IVR.md index f91ba02f8..603d5bc61 100644 --- a/build/docs/IVR.md +++ b/build/docs/IVR.md @@ -28,4 +28,4 @@ Defines the phone numbers, operating hours, and the Architect flows to execute f -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IVRDivisionView.md b/build/docs/IVRDivisionView.md index 2e3fdf783..76ade05d3 100644 --- a/build/docs/IVRDivisionView.md +++ b/build/docs/IVRDivisionView.md @@ -14,4 +14,4 @@ An ivr. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IVRDivisionViewEntityListing.md b/build/docs/IVRDivisionViewEntityListing.md index 05f7fb8dd..641c278d1 100644 --- a/build/docs/IVRDivisionViewEntityListing.md +++ b/build/docs/IVRDivisionViewEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IVREntityListing.md b/build/docs/IVREntityListing.md index d6ebb6585..c4c20de3c 100644 --- a/build/docs/IVREntityListing.md +++ b/build/docs/IVREntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdentifierClaimRequest.md b/build/docs/IdentifierClaimRequest.md index 220151891..cb1a22164 100644 --- a/build/docs/IdentifierClaimRequest.md +++ b/build/docs/IdentifierClaimRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdentityNow.md b/build/docs/IdentityNow.md index 849d1c7de..65f10f828 100644 --- a/build/docs/IdentityNow.md +++ b/build/docs/IdentityNow.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdentityProvider.md b/build/docs/IdentityProvider.md index b08552721..31d33ffc3 100644 --- a/build/docs/IdentityProvider.md +++ b/build/docs/IdentityProvider.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdentityProviderAPI.md b/build/docs/IdentityProviderAPI.md index ab5f4d043..51955fc7d 100644 --- a/build/docs/IdentityProviderAPI.md +++ b/build/docs/IdentityProviderAPI.md @@ -1865,4 +1865,4 @@ IdentityProviderAPI.putIdentityprovidersSalesforce(body: body) { (response, erro [**IdentityProvider**](IdentityProvider) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdentityProviderEntityListing.md b/build/docs/IdentityProviderEntityListing.md index d05e14175..081fc07f2 100644 --- a/build/docs/IdentityProviderEntityListing.md +++ b/build/docs/IdentityProviderEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdentityResolutionConfig.md b/build/docs/IdentityResolutionConfig.md index 6d9c85321..8929bb3d6 100644 --- a/build/docs/IdentityResolutionConfig.md +++ b/build/docs/IdentityResolutionConfig.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdentityResolutionQueueConfig.md b/build/docs/IdentityResolutionQueueConfig.md index 9eb8aa759..9b54199c8 100644 --- a/build/docs/IdentityResolutionQueueConfig.md +++ b/build/docs/IdentityResolutionQueueConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdleEventTrigger.md b/build/docs/IdleEventTrigger.md index 31cd1df44..522342d0a 100644 --- a/build/docs/IdleEventTrigger.md +++ b/build/docs/IdleEventTrigger.md @@ -12,4 +12,4 @@ Details about an idle event trigger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IdleTokenTimeout.md b/build/docs/IdleTokenTimeout.md index 7bb654540..9f4bd70e2 100644 --- a/build/docs/IdleTokenTimeout.md +++ b/build/docs/IdleTokenTimeout.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IgnoredActivityCategories.md b/build/docs/IgnoredActivityCategories.md index ef71d7026..4b2009b64 100644 --- a/build/docs/IgnoredActivityCategories.md +++ b/build/docs/IgnoredActivityCategories.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Image.md b/build/docs/Image.md index d4f7025c0..683fa7515 100644 --- a/build/docs/Image.md +++ b/build/docs/Image.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImapSettings.md b/build/docs/ImapSettings.md index 541856f7e..b60b80462 100644 --- a/build/docs/ImapSettings.md +++ b/build/docs/ImapSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportError.md b/build/docs/ImportError.md index 20549312c..56f9fe2ae 100644 --- a/build/docs/ImportError.md +++ b/build/docs/ImportError.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportForecastResponse.md b/build/docs/ImportForecastResponse.md index a674506c8..c01125b7a 100644 --- a/build/docs/ImportForecastResponse.md +++ b/build/docs/ImportForecastResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportForecastUploadResponse.md b/build/docs/ImportForecastUploadResponse.md index 534447c5b..985340cc2 100644 --- a/build/docs/ImportForecastUploadResponse.md +++ b/build/docs/ImportForecastUploadResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportReport.md b/build/docs/ImportReport.md index d4065c256..885ccc54d 100644 --- a/build/docs/ImportReport.md +++ b/build/docs/ImportReport.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportScheduleUploadResponse.md b/build/docs/ImportScheduleUploadResponse.md index 9f69611f7..a6dde6e18 100644 --- a/build/docs/ImportScheduleUploadResponse.md +++ b/build/docs/ImportScheduleUploadResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportScheduleUploadSchema.md b/build/docs/ImportScheduleUploadSchema.md index 9632c23b0..8c899d092 100644 --- a/build/docs/ImportScheduleUploadSchema.md +++ b/build/docs/ImportScheduleUploadSchema.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportScriptStatusResponse.md b/build/docs/ImportScriptStatusResponse.md index 3341d26c8..3519add17 100644 --- a/build/docs/ImportScriptStatusResponse.md +++ b/build/docs/ImportScriptStatusResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportStatus.md b/build/docs/ImportStatus.md index 82bf64fac..64af3fd3f 100644 --- a/build/docs/ImportStatus.md +++ b/build/docs/ImportStatus.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportStatusRequest.md b/build/docs/ImportStatusRequest.md index cd0c30657..fec75e178 100644 --- a/build/docs/ImportStatusRequest.md +++ b/build/docs/ImportStatusRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportTemplate.md b/build/docs/ImportTemplate.md index b0b229625..eb2a6f93a 100644 --- a/build/docs/ImportTemplate.md +++ b/build/docs/ImportTemplate.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportTemplateEntityListing.md b/build/docs/ImportTemplateEntityListing.md index bd94489c7..8d520a210 100644 --- a/build/docs/ImportTemplateEntityListing.md +++ b/build/docs/ImportTemplateEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportTemplateImportStatusImportStatus.md b/build/docs/ImportTemplateImportStatusImportStatus.md index 7962ff376..1d135cd88 100644 --- a/build/docs/ImportTemplateImportStatusImportStatus.md +++ b/build/docs/ImportTemplateImportStatusImportStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ImportTemplateImportStatusObject.md b/build/docs/ImportTemplateImportStatusObject.md index a849e61f2..61f743099 100644 --- a/build/docs/ImportTemplateImportStatusObject.md +++ b/build/docs/ImportTemplateImportStatusObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InboundDomain.md b/build/docs/InboundDomain.md index c03ec722d..1c03ff145 100644 --- a/build/docs/InboundDomain.md +++ b/build/docs/InboundDomain.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InboundDomainEntityListing.md b/build/docs/InboundDomainEntityListing.md index 5248e1b4d..1a8cf4125 100644 --- a/build/docs/InboundDomainEntityListing.md +++ b/build/docs/InboundDomainEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InboundDomainPatchRequest.md b/build/docs/InboundDomainPatchRequest.md index 2efd63bf0..08cd0a767 100644 --- a/build/docs/InboundDomainPatchRequest.md +++ b/build/docs/InboundDomainPatchRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InboundMessageRequest.md b/build/docs/InboundMessageRequest.md index 33233ae90..133ae67e9 100644 --- a/build/docs/InboundMessageRequest.md +++ b/build/docs/InboundMessageRequest.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InboundOnlySetting.md b/build/docs/InboundOnlySetting.md index 4c0a36bc0..26da94781 100644 --- a/build/docs/InboundOnlySetting.md +++ b/build/docs/InboundOnlySetting.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InboundRoute.md b/build/docs/InboundRoute.md index 2819a1ed4..7158b9645 100644 --- a/build/docs/InboundRoute.md +++ b/build/docs/InboundRoute.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InboundRouteEntityListing.md b/build/docs/InboundRouteEntityListing.md index 8e8e36a77..6e7fa75a2 100644 --- a/build/docs/InboundRouteEntityListing.md +++ b/build/docs/InboundRouteEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InfixOperator.md b/build/docs/InfixOperator.md index 3231f19ff..6f6c6fab4 100644 --- a/build/docs/InfixOperator.md +++ b/build/docs/InfixOperator.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InfrastructureAsCodeAPI.md b/build/docs/InfrastructureAsCodeAPI.md index be196a854..f4b4d8716 100644 --- a/build/docs/InfrastructureAsCodeAPI.md +++ b/build/docs/InfrastructureAsCodeAPI.md @@ -306,4 +306,4 @@ InfrastructureAsCodeAPI.postInfrastructureascodeJobs(body: body) { (response, er [**InfrastructureascodeJob**](InfrastructureascodeJob) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InfrastructureascodeJob.md b/build/docs/InfrastructureascodeJob.md index 95fa0fcd3..723cdaf5a 100644 --- a/build/docs/InfrastructureascodeJob.md +++ b/build/docs/InfrastructureascodeJob.md @@ -20,4 +20,4 @@ Information about a CX infrastructure as code job -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InitialConfiguration.md b/build/docs/InitialConfiguration.md index f2b141ef9..034cfc5da 100644 --- a/build/docs/InitialConfiguration.md +++ b/build/docs/InitialConfiguration.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InitiateScreenRecording.md b/build/docs/InitiateScreenRecording.md index 43abc5148..86e2f2c24 100644 --- a/build/docs/InitiateScreenRecording.md +++ b/build/docs/InitiateScreenRecording.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InitiatingAction.md b/build/docs/InitiatingAction.md index b5e90b56f..3d994eead 100644 --- a/build/docs/InitiatingAction.md +++ b/build/docs/InitiatingAction.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InitiatingAlternativeShift.md b/build/docs/InitiatingAlternativeShift.md index bf95036fd..38748545e 100644 --- a/build/docs/InitiatingAlternativeShift.md +++ b/build/docs/InitiatingAlternativeShift.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsAgentItem.md b/build/docs/InsightsAgentItem.md index 1b3cb4433..990ec5b41 100644 --- a/build/docs/InsightsAgentItem.md +++ b/build/docs/InsightsAgentItem.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsAgents.md b/build/docs/InsightsAgents.md index f0ac9a8d0..f258f634b 100644 --- a/build/docs/InsightsAgents.md +++ b/build/docs/InsightsAgents.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsDetails.md b/build/docs/InsightsDetails.md index 3b5b16b93..5d77cdfcb 100644 --- a/build/docs/InsightsDetails.md +++ b/build/docs/InsightsDetails.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsDetailsMetricItem.md b/build/docs/InsightsDetailsMetricItem.md index 718d0db59..01c509384 100644 --- a/build/docs/InsightsDetailsMetricItem.md +++ b/build/docs/InsightsDetailsMetricItem.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsDetailsMetricPeriodPoints.md b/build/docs/InsightsDetailsMetricPeriodPoints.md index 67e86c80d..ea6e2ead9 100644 --- a/build/docs/InsightsDetailsMetricPeriodPoints.md +++ b/build/docs/InsightsDetailsMetricPeriodPoints.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsDetailsOverallItem.md b/build/docs/InsightsDetailsOverallItem.md index ee03678cb..b810d7a3f 100644 --- a/build/docs/InsightsDetailsOverallItem.md +++ b/build/docs/InsightsDetailsOverallItem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsDetailsOverallPeriodPoints.md b/build/docs/InsightsDetailsOverallPeriodPoints.md index 6f5c4ca97..34cbcef15 100644 --- a/build/docs/InsightsDetailsOverallPeriodPoints.md +++ b/build/docs/InsightsDetailsOverallPeriodPoints.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsSummary.md b/build/docs/InsightsSummary.md index 2c831fb72..20614fb01 100644 --- a/build/docs/InsightsSummary.md +++ b/build/docs/InsightsSummary.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsSummaryMetricItem.md b/build/docs/InsightsSummaryMetricItem.md index 0d23ab9a8..4585db86d 100644 --- a/build/docs/InsightsSummaryMetricItem.md +++ b/build/docs/InsightsSummaryMetricItem.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsSummaryMetricPeriodPoints.md b/build/docs/InsightsSummaryMetricPeriodPoints.md index e46b67666..010b161b4 100644 --- a/build/docs/InsightsSummaryMetricPeriodPoints.md +++ b/build/docs/InsightsSummaryMetricPeriodPoints.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsSummaryOverallItem.md b/build/docs/InsightsSummaryOverallItem.md index 3406101d4..31ad1b3a6 100644 --- a/build/docs/InsightsSummaryOverallItem.md +++ b/build/docs/InsightsSummaryOverallItem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsSummaryOverallPeriodPoints.md b/build/docs/InsightsSummaryOverallPeriodPoints.md index 986c88dcc..e184d86a9 100644 --- a/build/docs/InsightsSummaryOverallPeriodPoints.md +++ b/build/docs/InsightsSummaryOverallPeriodPoints.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsSummaryUserItem.md b/build/docs/InsightsSummaryUserItem.md index 5328ea655..c7d8580ba 100644 --- a/build/docs/InsightsSummaryUserItem.md +++ b/build/docs/InsightsSummaryUserItem.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsTrend.md b/build/docs/InsightsTrend.md index 416a4f724..616e02c63 100644 --- a/build/docs/InsightsTrend.md +++ b/build/docs/InsightsTrend.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsTrendMetricItem.md b/build/docs/InsightsTrendMetricItem.md index 74002133a..d468ef166 100644 --- a/build/docs/InsightsTrendMetricItem.md +++ b/build/docs/InsightsTrendMetricItem.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsTrendTotalItem.md b/build/docs/InsightsTrendTotalItem.md index 8f7c6a75a..e870057fc 100644 --- a/build/docs/InsightsTrendTotalItem.md +++ b/build/docs/InsightsTrendTotalItem.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InsightsTrends.md b/build/docs/InsightsTrends.md index 83c0cfafc..dcf10a7de 100644 --- a/build/docs/InsightsTrends.md +++ b/build/docs/InsightsTrends.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InstagramId.md b/build/docs/InstagramId.md index 729e35de7..76761f770 100644 --- a/build/docs/InstagramId.md +++ b/build/docs/InstagramId.md @@ -13,4 +13,4 @@ User information for an Instagram account -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InstagramIntegration.md b/build/docs/InstagramIntegration.md index dc699a4c6..95a4b91bc 100644 --- a/build/docs/InstagramIntegration.md +++ b/build/docs/InstagramIntegration.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InstagramIntegrationEntityListing.md b/build/docs/InstagramIntegrationEntityListing.md index c9fc8475b..fac907447 100644 --- a/build/docs/InstagramIntegrationEntityListing.md +++ b/build/docs/InstagramIntegrationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InstagramIntegrationRequest.md b/build/docs/InstagramIntegrationRequest.md index fa9685546..f3bf59afd 100644 --- a/build/docs/InstagramIntegrationRequest.md +++ b/build/docs/InstagramIntegrationRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InstagramIntegrationUpdateRequest.md b/build/docs/InstagramIntegrationUpdateRequest.md index a5cbc9ed8..efdd2c437 100644 --- a/build/docs/InstagramIntegrationUpdateRequest.md +++ b/build/docs/InstagramIntegrationUpdateRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InstagramScopedId.md b/build/docs/InstagramScopedId.md index bcd42de1c..8172cad26 100644 --- a/build/docs/InstagramScopedId.md +++ b/build/docs/InstagramScopedId.md @@ -11,4 +11,4 @@ Scoped ID for an Instagram user interacting with a page or app -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Integration.md b/build/docs/Integration.md index 054550c4d..98011a944 100644 --- a/build/docs/Integration.md +++ b/build/docs/Integration.md @@ -19,4 +19,4 @@ Details for an Integration -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationAction.md b/build/docs/IntegrationAction.md index 7c46bd54f..b00b68ab7 100644 --- a/build/docs/IntegrationAction.md +++ b/build/docs/IntegrationAction.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationActionFields.md b/build/docs/IntegrationActionFields.md index 45ac683fa..05ef477df 100644 --- a/build/docs/IntegrationActionFields.md +++ b/build/docs/IntegrationActionFields.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationConfiguration.md b/build/docs/IntegrationConfiguration.md index f54d40150..9d8ed2d67 100644 --- a/build/docs/IntegrationConfiguration.md +++ b/build/docs/IntegrationConfiguration.md @@ -18,4 +18,4 @@ Configuration for an Integration -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationConfigurationInfo.md b/build/docs/IntegrationConfigurationInfo.md index 03df61336..f69aca3e9 100644 --- a/build/docs/IntegrationConfigurationInfo.md +++ b/build/docs/IntegrationConfigurationInfo.md @@ -11,4 +11,4 @@ Configuration information for the integration -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationEntityListing.md b/build/docs/IntegrationEntityListing.md index 0759646d7..febf2f515 100644 --- a/build/docs/IntegrationEntityListing.md +++ b/build/docs/IntegrationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationExport.md b/build/docs/IntegrationExport.md index e53f0586e..52c6ea26e 100644 --- a/build/docs/IntegrationExport.md +++ b/build/docs/IntegrationExport.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationStatusInfo.md b/build/docs/IntegrationStatusInfo.md index 4ebe7ad69..60deefc21 100644 --- a/build/docs/IntegrationStatusInfo.md +++ b/build/docs/IntegrationStatusInfo.md @@ -14,4 +14,4 @@ Status information for an Integration. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationType.md b/build/docs/IntegrationType.md index c491bcd47..4440fd9ee 100644 --- a/build/docs/IntegrationType.md +++ b/build/docs/IntegrationType.md @@ -34,4 +34,4 @@ Descriptor for a type of Integration. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationTypeEntityListing.md b/build/docs/IntegrationTypeEntityListing.md index 64fa06c98..a0aca4315 100644 --- a/build/docs/IntegrationTypeEntityListing.md +++ b/build/docs/IntegrationTypeEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntegrationsAPI.md b/build/docs/IntegrationsAPI.md index c09596a0b..8f51e6bc5 100644 --- a/build/docs/IntegrationsAPI.md +++ b/build/docs/IntegrationsAPI.md @@ -4388,4 +4388,4 @@ IntegrationsAPI.putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegra **String** -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Intent.md b/build/docs/Intent.md index a3ebef7ee..61405d94b 100644 --- a/build/docs/Intent.md +++ b/build/docs/Intent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntentDefinition.md b/build/docs/IntentDefinition.md index d73d019b6..f693dabb5 100644 --- a/build/docs/IntentDefinition.md +++ b/build/docs/IntentDefinition.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntentFeedback.md b/build/docs/IntentFeedback.md index fc6dd26cc..2ec5ce925 100644 --- a/build/docs/IntentFeedback.md +++ b/build/docs/IntentFeedback.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InteractionStatsAlert.md b/build/docs/InteractionStatsAlert.md index e5ee04c90..8af93f377 100644 --- a/build/docs/InteractionStatsAlert.md +++ b/build/docs/InteractionStatsAlert.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InteractionStatsAlertContainer.md b/build/docs/InteractionStatsAlertContainer.md index 88533f244..8ca347ee7 100644 --- a/build/docs/InteractionStatsAlertContainer.md +++ b/build/docs/InteractionStatsAlertContainer.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InteractionStatsRule.md b/build/docs/InteractionStatsRule.md index e5f00e345..d00cc39be 100644 --- a/build/docs/InteractionStatsRule.md +++ b/build/docs/InteractionStatsRule.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InteractionStatsRuleContainer.md b/build/docs/InteractionStatsRuleContainer.md index b6fb8d230..75a51ba40 100644 --- a/build/docs/InteractionStatsRuleContainer.md +++ b/build/docs/InteractionStatsRuleContainer.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InternalMessage.md b/build/docs/InternalMessage.md index 9c51b3b12..89657a124 100644 --- a/build/docs/InternalMessage.md +++ b/build/docs/InternalMessage.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InternalMessageDetails.md b/build/docs/InternalMessageDetails.md index c74b5bd09..73f99d20a 100644 --- a/build/docs/InternalMessageDetails.md +++ b/build/docs/InternalMessageDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntradayPerformancePredictionData.md b/build/docs/IntradayPerformancePredictionData.md index 063ceaff9..131b6259b 100644 --- a/build/docs/IntradayPerformancePredictionData.md +++ b/build/docs/IntradayPerformancePredictionData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IntradayPlanningGroupRequest.md b/build/docs/IntradayPlanningGroupRequest.md index ada6c5d85..3c4586276 100644 --- a/build/docs/IntradayPlanningGroupRequest.md +++ b/build/docs/IntradayPlanningGroupRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/InvalidAssignment.md b/build/docs/InvalidAssignment.md index 3db054ef3..31231724f 100644 --- a/build/docs/InvalidAssignment.md +++ b/build/docs/InvalidAssignment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IpAddressAuthentication.md b/build/docs/IpAddressAuthentication.md index b050fd98a..56a8c0663 100644 --- a/build/docs/IpAddressAuthentication.md +++ b/build/docs/IpAddressAuthentication.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IpAddressRange.md b/build/docs/IpAddressRange.md index d365e7700..1f737926e 100644 --- a/build/docs/IpAddressRange.md +++ b/build/docs/IpAddressRange.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IpAddressRangeListing.md b/build/docs/IpAddressRangeListing.md index 66caf27ab..df1b113d5 100644 --- a/build/docs/IpAddressRangeListing.md +++ b/build/docs/IpAddressRangeListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ItemValidationLimits.md b/build/docs/ItemValidationLimits.md index 8042d0bfe..0a37cdd0e 100644 --- a/build/docs/ItemValidationLimits.md +++ b/build/docs/ItemValidationLimits.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Items.md b/build/docs/Items.md index bed37a761..720e2ecf9 100644 --- a/build/docs/Items.md +++ b/build/docs/Items.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/IvrEstablishedEvent.md b/build/docs/IvrEstablishedEvent.md index dc570ab6f..cbecc155b 100644 --- a/build/docs/IvrEstablishedEvent.md +++ b/build/docs/IvrEstablishedEvent.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Journey.md b/build/docs/Journey.md index 913303c3c..4cde8510e 100644 --- a/build/docs/Journey.md +++ b/build/docs/Journey.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAPI.md b/build/docs/JourneyAPI.md index f0e805058..5168abbeb 100644 --- a/build/docs/JourneyAPI.md +++ b/build/docs/JourneyAPI.md @@ -377,8 +377,6 @@ JourneyAPI.deleteJourneyView(viewId: viewId) { (error) in Delete the Schedule of a JourneyView -used for long descriptions - Wraps DELETE /api/v2/journey/views/{viewId}/schedules @@ -1501,8 +1499,6 @@ JourneyAPI.getJourneyView(viewId: viewId) { (response, error) in Get the Schedule for a JourneyView -used for long descriptions - Wraps GET /api/v2/journey/views/{viewId}/schedules @@ -1717,8 +1713,6 @@ JourneyAPI.getJourneyViewVersionChartVersion(viewId: viewId, journeyViewVersion: Get the job for a journey view version. -used for long descriptions - Wraps GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} @@ -1773,8 +1767,6 @@ JourneyAPI.getJourneyViewVersionJob(viewId: viewId, journeyVersionId: journeyVer Get the result of a job for a journey view version. -used for long descriptions - Wraps GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results @@ -1885,8 +1877,6 @@ JourneyAPI.getJourneyViewVersionJobResultsChart(viewId: viewId, journeyVersionId Get the latest job of a journey view version. -used for long descriptions - Wraps GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest @@ -2461,8 +2451,6 @@ JourneyAPI.patchJourneySegment(segmentId: segmentId, body: body) { (response, er Update the job for a journey view version. Only the status can be changed and only to Cancelled -used for long descriptions - Wraps PATCH /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} @@ -3123,8 +3111,6 @@ JourneyAPI.postJourneyViewSchedules(viewId: viewId, body: body) { (response, err Submit a job request for a journey view version. -used for long descriptions - Wraps POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs @@ -3333,8 +3319,6 @@ JourneyAPI.postJourneyViewsEncodingsValidate(body: body) { (response, error) in Update the Schedule for a JourneyView -used for long descriptions - Wraps PUT /api/v2/journey/views/{viewId}/schedules @@ -3435,4 +3419,4 @@ JourneyAPI.putJourneyViewVersion(viewId: viewId, versionId: versionId, body: bod [**JourneyView**](JourneyView) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAction.md b/build/docs/JourneyAction.md index 01ed93bbb..1021fbd2a 100644 --- a/build/docs/JourneyAction.md +++ b/build/docs/JourneyAction.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyActionMap.md b/build/docs/JourneyActionMap.md index 1625f2d26..47e02e4f0 100644 --- a/build/docs/JourneyActionMap.md +++ b/build/docs/JourneyActionMap.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAggregateDataContainer.md b/build/docs/JourneyAggregateDataContainer.md index 742a2a6c0..50055fabc 100644 --- a/build/docs/JourneyAggregateDataContainer.md +++ b/build/docs/JourneyAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAggregateQueryClause.md b/build/docs/JourneyAggregateQueryClause.md index 994b6b3c6..ed973481e 100644 --- a/build/docs/JourneyAggregateQueryClause.md +++ b/build/docs/JourneyAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAggregateQueryFilter.md b/build/docs/JourneyAggregateQueryFilter.md index f223872f1..d4fc59a1a 100644 --- a/build/docs/JourneyAggregateQueryFilter.md +++ b/build/docs/JourneyAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAggregateQueryPredicate.md b/build/docs/JourneyAggregateQueryPredicate.md index 2077062df..a3273d536 100644 --- a/build/docs/JourneyAggregateQueryPredicate.md +++ b/build/docs/JourneyAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAggregateQueryResponse.md b/build/docs/JourneyAggregateQueryResponse.md index 89f8d06e1..1ed2abb52 100644 --- a/build/docs/JourneyAggregateQueryResponse.md +++ b/build/docs/JourneyAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAggregationQuery.md b/build/docs/JourneyAggregationQuery.md index 2c396262d..1096a1ed6 100644 --- a/build/docs/JourneyAggregationQuery.md +++ b/build/docs/JourneyAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAggregationView.md b/build/docs/JourneyAggregationView.md index e61708341..8f8d71daf 100644 --- a/build/docs/JourneyAggregationView.md +++ b/build/docs/JourneyAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyApp.md b/build/docs/JourneyApp.md index ccf69eeff..6f64803d3 100644 --- a/build/docs/JourneyApp.md +++ b/build/docs/JourneyApp.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationActionMap.md b/build/docs/JourneyAppEventsNotificationActionMap.md index 15a2663cb..112dc152f 100644 --- a/build/docs/JourneyAppEventsNotificationActionMap.md +++ b/build/docs/JourneyAppEventsNotificationActionMap.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationActionTarget.md b/build/docs/JourneyAppEventsNotificationActionTarget.md index 6fc7769a0..48bfc3cc2 100644 --- a/build/docs/JourneyAppEventsNotificationActionTarget.md +++ b/build/docs/JourneyAppEventsNotificationActionTarget.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationApp.md b/build/docs/JourneyAppEventsNotificationApp.md index 2b1b34e58..e380ef94f 100644 --- a/build/docs/JourneyAppEventsNotificationApp.md +++ b/build/docs/JourneyAppEventsNotificationApp.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationAppEventsNotification.md b/build/docs/JourneyAppEventsNotificationAppEventsNotification.md index ed35f6516..49d0729ad 100644 --- a/build/docs/JourneyAppEventsNotificationAppEventsNotification.md +++ b/build/docs/JourneyAppEventsNotificationAppEventsNotification.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationAppMessage.md b/build/docs/JourneyAppEventsNotificationAppMessage.md index a15a82ef7..afafe5cfc 100644 --- a/build/docs/JourneyAppEventsNotificationAppMessage.md +++ b/build/docs/JourneyAppEventsNotificationAppMessage.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationAssociatedValue.md b/build/docs/JourneyAppEventsNotificationAssociatedValue.md index ca6e8927e..d5d74f01b 100644 --- a/build/docs/JourneyAppEventsNotificationAssociatedValue.md +++ b/build/docs/JourneyAppEventsNotificationAssociatedValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationBrowser.md b/build/docs/JourneyAppEventsNotificationBrowser.md index b7d3d75f3..561f6bbc7 100644 --- a/build/docs/JourneyAppEventsNotificationBrowser.md +++ b/build/docs/JourneyAppEventsNotificationBrowser.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationCustomEventAttribute.md b/build/docs/JourneyAppEventsNotificationCustomEventAttribute.md index 4701062e6..b3558ff36 100644 --- a/build/docs/JourneyAppEventsNotificationCustomEventAttribute.md +++ b/build/docs/JourneyAppEventsNotificationCustomEventAttribute.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationDevice.md b/build/docs/JourneyAppEventsNotificationDevice.md index 8bc5b2c21..0408e3a06 100644 --- a/build/docs/JourneyAppEventsNotificationDevice.md +++ b/build/docs/JourneyAppEventsNotificationDevice.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationEventAction.md b/build/docs/JourneyAppEventsNotificationEventAction.md index 1f4221e13..4bfa4e090 100644 --- a/build/docs/JourneyAppEventsNotificationEventAction.md +++ b/build/docs/JourneyAppEventsNotificationEventAction.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationExternalContact.md b/build/docs/JourneyAppEventsNotificationExternalContact.md index 7178b2ed9..19723a1b6 100644 --- a/build/docs/JourneyAppEventsNotificationExternalContact.md +++ b/build/docs/JourneyAppEventsNotificationExternalContact.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationGeoLocation.md b/build/docs/JourneyAppEventsNotificationGeoLocation.md index 72da158fe..d175d3acf 100644 --- a/build/docs/JourneyAppEventsNotificationGeoLocation.md +++ b/build/docs/JourneyAppEventsNotificationGeoLocation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationMktCampaign.md b/build/docs/JourneyAppEventsNotificationMktCampaign.md index 8672b02fb..87e4ebb13 100644 --- a/build/docs/JourneyAppEventsNotificationMktCampaign.md +++ b/build/docs/JourneyAppEventsNotificationMktCampaign.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationNetworkConnectivity.md b/build/docs/JourneyAppEventsNotificationNetworkConnectivity.md index 8a4704181..5c2945921 100644 --- a/build/docs/JourneyAppEventsNotificationNetworkConnectivity.md +++ b/build/docs/JourneyAppEventsNotificationNetworkConnectivity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationOutcome.md b/build/docs/JourneyAppEventsNotificationOutcome.md index d49449467..74775c286 100644 --- a/build/docs/JourneyAppEventsNotificationOutcome.md +++ b/build/docs/JourneyAppEventsNotificationOutcome.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationOutcomeAchievedMessage.md b/build/docs/JourneyAppEventsNotificationOutcomeAchievedMessage.md index 5578e3641..42af5a391 100644 --- a/build/docs/JourneyAppEventsNotificationOutcomeAchievedMessage.md +++ b/build/docs/JourneyAppEventsNotificationOutcomeAchievedMessage.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationReferrer.md b/build/docs/JourneyAppEventsNotificationReferrer.md index e47ae610e..47102683c 100644 --- a/build/docs/JourneyAppEventsNotificationReferrer.md +++ b/build/docs/JourneyAppEventsNotificationReferrer.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationSdkLibrary.md b/build/docs/JourneyAppEventsNotificationSdkLibrary.md index dfdb6db73..71d490e43 100644 --- a/build/docs/JourneyAppEventsNotificationSdkLibrary.md +++ b/build/docs/JourneyAppEventsNotificationSdkLibrary.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationSegment.md b/build/docs/JourneyAppEventsNotificationSegment.md index cb480d77c..6c7930993 100644 --- a/build/docs/JourneyAppEventsNotificationSegment.md +++ b/build/docs/JourneyAppEventsNotificationSegment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationSegmentAssignmentMessage.md b/build/docs/JourneyAppEventsNotificationSegmentAssignmentMessage.md index f7637abfb..d3866b058 100644 --- a/build/docs/JourneyAppEventsNotificationSegmentAssignmentMessage.md +++ b/build/docs/JourneyAppEventsNotificationSegmentAssignmentMessage.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationSession.md b/build/docs/JourneyAppEventsNotificationSession.md index 77239e7b7..302784c52 100644 --- a/build/docs/JourneyAppEventsNotificationSession.md +++ b/build/docs/JourneyAppEventsNotificationSession.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyAppEventsNotificationWebActionMessage.md b/build/docs/JourneyAppEventsNotificationWebActionMessage.md index c6399f103..66cd01c1e 100644 --- a/build/docs/JourneyAppEventsNotificationWebActionMessage.md +++ b/build/docs/JourneyAppEventsNotificationWebActionMessage.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyCampaign.md b/build/docs/JourneyCampaign.md index 8e14ff329..ee7456212 100644 --- a/build/docs/JourneyCampaign.md +++ b/build/docs/JourneyCampaign.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyContext.md b/build/docs/JourneyContext.md index 7a8612775..ef073511c 100644 --- a/build/docs/JourneyContext.md +++ b/build/docs/JourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyCustomer.md b/build/docs/JourneyCustomer.md index ea571ebb7..52b5c65f6 100644 --- a/build/docs/JourneyCustomer.md +++ b/build/docs/JourneyCustomer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyCustomerSession.md b/build/docs/JourneyCustomerSession.md index c27db8183..82d742baa 100644 --- a/build/docs/JourneyCustomerSession.md +++ b/build/docs/JourneyCustomerSession.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyEventDefinition.md b/build/docs/JourneyEventDefinition.md index 539f7500e..66117f153 100644 --- a/build/docs/JourneyEventDefinition.md +++ b/build/docs/JourneyEventDefinition.md @@ -16,4 +16,4 @@ An event definition used when creating journey views -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyEventDefinitionListing.md b/build/docs/JourneyEventDefinitionListing.md index 9df0f8658..1b97655cc 100644 --- a/build/docs/JourneyEventDefinitionListing.md +++ b/build/docs/JourneyEventDefinitionListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyEventsSettings.md b/build/docs/JourneyEventsSettings.md index f4136a43b..93379dd2c 100644 --- a/build/docs/JourneyEventsSettings.md +++ b/build/docs/JourneyEventsSettings.md @@ -20,4 +20,4 @@ Settings concerning journey events -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyGeolocation.md b/build/docs/JourneyGeolocation.md index 775409d5c..c7e15821d 100644 --- a/build/docs/JourneyGeolocation.md +++ b/build/docs/JourneyGeolocation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationActionMap.md b/build/docs/JourneyOutcomeEventsNotificationActionMap.md index 271e688fa..b35a7b334 100644 --- a/build/docs/JourneyOutcomeEventsNotificationActionMap.md +++ b/build/docs/JourneyOutcomeEventsNotificationActionMap.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationAssociatedValue.md b/build/docs/JourneyOutcomeEventsNotificationAssociatedValue.md index acacb8658..4ff43a520 100644 --- a/build/docs/JourneyOutcomeEventsNotificationAssociatedValue.md +++ b/build/docs/JourneyOutcomeEventsNotificationAssociatedValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationBrowser.md b/build/docs/JourneyOutcomeEventsNotificationBrowser.md index af8ca758f..7d169745f 100644 --- a/build/docs/JourneyOutcomeEventsNotificationBrowser.md +++ b/build/docs/JourneyOutcomeEventsNotificationBrowser.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationDevice.md b/build/docs/JourneyOutcomeEventsNotificationDevice.md index 37a85f028..06ea7ee0b 100644 --- a/build/docs/JourneyOutcomeEventsNotificationDevice.md +++ b/build/docs/JourneyOutcomeEventsNotificationDevice.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationExternalContact.md b/build/docs/JourneyOutcomeEventsNotificationExternalContact.md index 36d3f134a..7d4b34840 100644 --- a/build/docs/JourneyOutcomeEventsNotificationExternalContact.md +++ b/build/docs/JourneyOutcomeEventsNotificationExternalContact.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationGeoLocation.md b/build/docs/JourneyOutcomeEventsNotificationGeoLocation.md index 4e4293c0e..79760a7c3 100644 --- a/build/docs/JourneyOutcomeEventsNotificationGeoLocation.md +++ b/build/docs/JourneyOutcomeEventsNotificationGeoLocation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationMktCampaign.md b/build/docs/JourneyOutcomeEventsNotificationMktCampaign.md index cf3d7d502..181d24086 100644 --- a/build/docs/JourneyOutcomeEventsNotificationMktCampaign.md +++ b/build/docs/JourneyOutcomeEventsNotificationMktCampaign.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationOutcome.md b/build/docs/JourneyOutcomeEventsNotificationOutcome.md index 11ca3c1a8..9d7abc783 100644 --- a/build/docs/JourneyOutcomeEventsNotificationOutcome.md +++ b/build/docs/JourneyOutcomeEventsNotificationOutcome.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationOutcomeAchievedMessage.md b/build/docs/JourneyOutcomeEventsNotificationOutcomeAchievedMessage.md index 1a0dd83d4..9073280c9 100644 --- a/build/docs/JourneyOutcomeEventsNotificationOutcomeAchievedMessage.md +++ b/build/docs/JourneyOutcomeEventsNotificationOutcomeAchievedMessage.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationOutcomeAttributionMessage.md b/build/docs/JourneyOutcomeEventsNotificationOutcomeAttributionMessage.md index 620d20572..4df263404 100644 --- a/build/docs/JourneyOutcomeEventsNotificationOutcomeAttributionMessage.md +++ b/build/docs/JourneyOutcomeEventsNotificationOutcomeAttributionMessage.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationOutcomeEventsNotification.md b/build/docs/JourneyOutcomeEventsNotificationOutcomeEventsNotification.md index d0c9616c9..4fa3ced97 100644 --- a/build/docs/JourneyOutcomeEventsNotificationOutcomeEventsNotification.md +++ b/build/docs/JourneyOutcomeEventsNotificationOutcomeEventsNotification.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationOutcomeTouchpoint.md b/build/docs/JourneyOutcomeEventsNotificationOutcomeTouchpoint.md index 74c95aa8f..742beb4f7 100644 --- a/build/docs/JourneyOutcomeEventsNotificationOutcomeTouchpoint.md +++ b/build/docs/JourneyOutcomeEventsNotificationOutcomeTouchpoint.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationOutcomeTouchpointChannel.md b/build/docs/JourneyOutcomeEventsNotificationOutcomeTouchpointChannel.md index c522f42c1..605eb98b4 100644 --- a/build/docs/JourneyOutcomeEventsNotificationOutcomeTouchpointChannel.md +++ b/build/docs/JourneyOutcomeEventsNotificationOutcomeTouchpointChannel.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationReferrer.md b/build/docs/JourneyOutcomeEventsNotificationReferrer.md index 43de15cc5..cbce44ab8 100644 --- a/build/docs/JourneyOutcomeEventsNotificationReferrer.md +++ b/build/docs/JourneyOutcomeEventsNotificationReferrer.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationSegment.md b/build/docs/JourneyOutcomeEventsNotificationSegment.md index 69d799c1e..8adec0415 100644 --- a/build/docs/JourneyOutcomeEventsNotificationSegment.md +++ b/build/docs/JourneyOutcomeEventsNotificationSegment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyOutcomeEventsNotificationSession.md b/build/docs/JourneyOutcomeEventsNotificationSession.md index 61e396cb5..5f146b77b 100644 --- a/build/docs/JourneyOutcomeEventsNotificationSession.md +++ b/build/docs/JourneyOutcomeEventsNotificationSession.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyPage.md b/build/docs/JourneyPage.md index 017f03b7c..9749de6b5 100644 --- a/build/docs/JourneyPage.md +++ b/build/docs/JourneyPage.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyPattern.md b/build/docs/JourneyPattern.md index 8298d294a..5c5d0d5c7 100644 --- a/build/docs/JourneyPattern.md +++ b/build/docs/JourneyPattern.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySegment.md b/build/docs/JourneySegment.md index 1c424dced..093e77f1b 100644 --- a/build/docs/JourneySegment.md +++ b/build/docs/JourneySegment.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySegmentRequest.md b/build/docs/JourneySegmentRequest.md index 2cd5bbaa7..618a7ead3 100644 --- a/build/docs/JourneySegmentRequest.md +++ b/build/docs/JourneySegmentRequest.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationApp.md b/build/docs/JourneySessionEventsNotificationApp.md index 45afeba30..6f57b0bac 100644 --- a/build/docs/JourneySessionEventsNotificationApp.md +++ b/build/docs/JourneySessionEventsNotificationApp.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationBrowser.md b/build/docs/JourneySessionEventsNotificationBrowser.md index d38d53994..1a0bdb203 100644 --- a/build/docs/JourneySessionEventsNotificationBrowser.md +++ b/build/docs/JourneySessionEventsNotificationBrowser.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationConnectedQueue.md b/build/docs/JourneySessionEventsNotificationConnectedQueue.md index bdf5cb3e3..0c5aa716c 100644 --- a/build/docs/JourneySessionEventsNotificationConnectedQueue.md +++ b/build/docs/JourneySessionEventsNotificationConnectedQueue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationConversation.md b/build/docs/JourneySessionEventsNotificationConversation.md index b88152273..4cc119ef6 100644 --- a/build/docs/JourneySessionEventsNotificationConversation.md +++ b/build/docs/JourneySessionEventsNotificationConversation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationConversationChannel.md b/build/docs/JourneySessionEventsNotificationConversationChannel.md index e05c4c21d..1e496b1a5 100644 --- a/build/docs/JourneySessionEventsNotificationConversationChannel.md +++ b/build/docs/JourneySessionEventsNotificationConversationChannel.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationConversationUserDisposition.md b/build/docs/JourneySessionEventsNotificationConversationUserDisposition.md index bf0332be9..3a39cd61e 100644 --- a/build/docs/JourneySessionEventsNotificationConversationUserDisposition.md +++ b/build/docs/JourneySessionEventsNotificationConversationUserDisposition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationDevice.md b/build/docs/JourneySessionEventsNotificationDevice.md index 60a8c1aa1..50c642b92 100644 --- a/build/docs/JourneySessionEventsNotificationDevice.md +++ b/build/docs/JourneySessionEventsNotificationDevice.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationExternalContact.md b/build/docs/JourneySessionEventsNotificationExternalContact.md index c353f31ff..64a903e54 100644 --- a/build/docs/JourneySessionEventsNotificationExternalContact.md +++ b/build/docs/JourneySessionEventsNotificationExternalContact.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationGeoLocation.md b/build/docs/JourneySessionEventsNotificationGeoLocation.md index 58ac46e42..9bae688dd 100644 --- a/build/docs/JourneySessionEventsNotificationGeoLocation.md +++ b/build/docs/JourneySessionEventsNotificationGeoLocation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationMktCampaign.md b/build/docs/JourneySessionEventsNotificationMktCampaign.md index 28cd1001f..7ea7a9892 100644 --- a/build/docs/JourneySessionEventsNotificationMktCampaign.md +++ b/build/docs/JourneySessionEventsNotificationMktCampaign.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationNetworkConnectivity.md b/build/docs/JourneySessionEventsNotificationNetworkConnectivity.md index 2046293ec..519d4b6aa 100644 --- a/build/docs/JourneySessionEventsNotificationNetworkConnectivity.md +++ b/build/docs/JourneySessionEventsNotificationNetworkConnectivity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationOutcome.md b/build/docs/JourneySessionEventsNotificationOutcome.md index 005375677..b7665d7d3 100644 --- a/build/docs/JourneySessionEventsNotificationOutcome.md +++ b/build/docs/JourneySessionEventsNotificationOutcome.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationOutcomeAchievement.md b/build/docs/JourneySessionEventsNotificationOutcomeAchievement.md index 244b41a8d..8a3415401 100644 --- a/build/docs/JourneySessionEventsNotificationOutcomeAchievement.md +++ b/build/docs/JourneySessionEventsNotificationOutcomeAchievement.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationPage.md b/build/docs/JourneySessionEventsNotificationPage.md index 4d737372a..be81e75be 100644 --- a/build/docs/JourneySessionEventsNotificationPage.md +++ b/build/docs/JourneySessionEventsNotificationPage.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationReferrer.md b/build/docs/JourneySessionEventsNotificationReferrer.md index 624994f66..e7a5d0597 100644 --- a/build/docs/JourneySessionEventsNotificationReferrer.md +++ b/build/docs/JourneySessionEventsNotificationReferrer.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationSdkLibrary.md b/build/docs/JourneySessionEventsNotificationSdkLibrary.md index 2ab66077f..5c5e41221 100644 --- a/build/docs/JourneySessionEventsNotificationSdkLibrary.md +++ b/build/docs/JourneySessionEventsNotificationSdkLibrary.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationSegment.md b/build/docs/JourneySessionEventsNotificationSegment.md index 27a4a0025..f6079c46c 100644 --- a/build/docs/JourneySessionEventsNotificationSegment.md +++ b/build/docs/JourneySessionEventsNotificationSegment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationSegmentAssignment.md b/build/docs/JourneySessionEventsNotificationSegmentAssignment.md index 0b1a3eefc..7534ee155 100644 --- a/build/docs/JourneySessionEventsNotificationSegmentAssignment.md +++ b/build/docs/JourneySessionEventsNotificationSegmentAssignment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationSessionEvent.md b/build/docs/JourneySessionEventsNotificationSessionEvent.md index 483526ce7..a3cd8677c 100644 --- a/build/docs/JourneySessionEventsNotificationSessionEvent.md +++ b/build/docs/JourneySessionEventsNotificationSessionEvent.md @@ -51,4 +51,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationSessionLastEvent.md b/build/docs/JourneySessionEventsNotificationSessionLastEvent.md index fd4c8ffc2..abb71fc72 100644 --- a/build/docs/JourneySessionEventsNotificationSessionLastEvent.md +++ b/build/docs/JourneySessionEventsNotificationSessionLastEvent.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySessionEventsNotificationUser.md b/build/docs/JourneySessionEventsNotificationUser.md index 38464292c..b2593b3f1 100644 --- a/build/docs/JourneySessionEventsNotificationUser.md +++ b/build/docs/JourneySessionEventsNotificationUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneySurveyQuestion.md b/build/docs/JourneySurveyQuestion.md index 34800293f..973654022 100644 --- a/build/docs/JourneySurveyQuestion.md +++ b/build/docs/JourneySurveyQuestion.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyView.md b/build/docs/JourneyView.md index e06623ac7..e918ed52a 100644 --- a/build/docs/JourneyView.md +++ b/build/docs/JourneyView.md @@ -23,4 +23,4 @@ A journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewChart.md b/build/docs/JourneyViewChart.md index 37a14423d..8616be449 100644 --- a/build/docs/JourneyViewChart.md +++ b/build/docs/JourneyViewChart.md @@ -19,4 +19,4 @@ A chart within the context of the elements of the the journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewChartDisplayAttributes.md b/build/docs/JourneyViewChartDisplayAttributes.md index 4bb294477..67c7a0240 100644 --- a/build/docs/JourneyViewChartDisplayAttributes.md +++ b/build/docs/JourneyViewChartDisplayAttributes.md @@ -14,4 +14,4 @@ Display attributes for the chart, such as type, labels and legends -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewChartGroupByAttribute.md b/build/docs/JourneyViewChartGroupByAttribute.md index b12776142..2a449e1b1 100644 --- a/build/docs/JourneyViewChartGroupByAttribute.md +++ b/build/docs/JourneyViewChartGroupByAttribute.md @@ -12,4 +12,4 @@ A journey element attribute to group by within the chart -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewChartMetric.md b/build/docs/JourneyViewChartMetric.md index 5b0fa0b73..47320af49 100644 --- a/build/docs/JourneyViewChartMetric.md +++ b/build/docs/JourneyViewChartMetric.md @@ -14,4 +14,4 @@ A metric to measure within the chart -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewChartMetricResult.md b/build/docs/JourneyViewChartMetricResult.md index 9f740186f..8f2b6040b 100644 --- a/build/docs/JourneyViewChartMetricResult.md +++ b/build/docs/JourneyViewChartMetricResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewChartMetricResultValue.md b/build/docs/JourneyViewChartMetricResultValue.md index 08c74d807..5e1ee37f5 100644 --- a/build/docs/JourneyViewChartMetricResultValue.md +++ b/build/docs/JourneyViewChartMetricResultValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewChartResult.md b/build/docs/JourneyViewChartResult.md index adab2d39b..5fbac413e 100644 --- a/build/docs/JourneyViewChartResult.md +++ b/build/docs/JourneyViewChartResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewElement.md b/build/docs/JourneyViewElement.md index 563eb46de..ed6e32cf6 100644 --- a/build/docs/JourneyViewElement.md +++ b/build/docs/JourneyViewElement.md @@ -16,4 +16,4 @@ An element within a journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewElementAttributes.md b/build/docs/JourneyViewElementAttributes.md index ef723ef0e..459b4a175 100644 --- a/build/docs/JourneyViewElementAttributes.md +++ b/build/docs/JourneyViewElementAttributes.md @@ -13,4 +13,4 @@ Attributes on an element in a journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewElementDisplayAttributes.md b/build/docs/JourneyViewElementDisplayAttributes.md index 84f8579ce..e4b6001b7 100644 --- a/build/docs/JourneyViewElementDisplayAttributes.md +++ b/build/docs/JourneyViewElementDisplayAttributes.md @@ -13,4 +13,4 @@ Display attributes for an element in a journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewElementFilter.md b/build/docs/JourneyViewElementFilter.md index 98818f1de..7a6f61a3f 100644 --- a/build/docs/JourneyViewElementFilter.md +++ b/build/docs/JourneyViewElementFilter.md @@ -12,4 +12,4 @@ A set of filters on an element within a journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewElementFilterNumberPredicate.md b/build/docs/JourneyViewElementFilterNumberPredicate.md index ca9d3c60a..3cb342ac3 100644 --- a/build/docs/JourneyViewElementFilterNumberPredicate.md +++ b/build/docs/JourneyViewElementFilterNumberPredicate.md @@ -14,4 +14,4 @@ A numeric filter on an element within a journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewElementFilterPredicate.md b/build/docs/JourneyViewElementFilterPredicate.md index 0c36c349e..b2fef5d90 100644 --- a/build/docs/JourneyViewElementFilterPredicate.md +++ b/build/docs/JourneyViewElementFilterPredicate.md @@ -14,4 +14,4 @@ A filter on an element within a journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewElementFilterRange.md b/build/docs/JourneyViewElementFilterRange.md index 1c3276363..9b831d401 100644 --- a/build/docs/JourneyViewElementFilterRange.md +++ b/build/docs/JourneyViewElementFilterRange.md @@ -16,4 +16,4 @@ the range of attribute values to filter on. At least one comparator must be defi -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewElementFilterRangeData.md b/build/docs/JourneyViewElementFilterRangeData.md index 206106793..f8fb3f6cd 100644 --- a/build/docs/JourneyViewElementFilterRangeData.md +++ b/build/docs/JourneyViewElementFilterRangeData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewJob.md b/build/docs/JourneyViewJob.md index 42684e001..35e56a02f 100644 --- a/build/docs/JourneyViewJob.md +++ b/build/docs/JourneyViewJob.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewJobListing.md b/build/docs/JourneyViewJobListing.md index cd075efc0..79e138e4a 100644 --- a/build/docs/JourneyViewJobListing.md +++ b/build/docs/JourneyViewJobListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewLink.md b/build/docs/JourneyViewLink.md index 6e73bbc57..263c2882a 100644 --- a/build/docs/JourneyViewLink.md +++ b/build/docs/JourneyViewLink.md @@ -15,4 +15,4 @@ A link between elements in a journey view -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewLinkTimeConstraint.md b/build/docs/JourneyViewLinkTimeConstraint.md index b1b37210a..7addf7497 100644 --- a/build/docs/JourneyViewLinkTimeConstraint.md +++ b/build/docs/JourneyViewLinkTimeConstraint.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewListing.md b/build/docs/JourneyViewListing.md index 3630490df..74d09f9b4 100644 --- a/build/docs/JourneyViewListing.md +++ b/build/docs/JourneyViewListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewResult.md b/build/docs/JourneyViewResult.md index ff9b09e66..268b26e61 100644 --- a/build/docs/JourneyViewResult.md +++ b/build/docs/JourneyViewResult.md @@ -11,4 +11,4 @@ A journey view result -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewResultElement.md b/build/docs/JourneyViewResultElement.md index 35ea0461b..8d789562f 100644 --- a/build/docs/JourneyViewResultElement.md +++ b/build/docs/JourneyViewResultElement.md @@ -14,4 +14,4 @@ An element within a journey view result -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewResultLink.md b/build/docs/JourneyViewResultLink.md index 798801fb4..4d8a7b53e 100644 --- a/build/docs/JourneyViewResultLink.md +++ b/build/docs/JourneyViewResultLink.md @@ -13,4 +13,4 @@ Represents a link between 2 elements in a journey view result -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewResultMetrics.md b/build/docs/JourneyViewResultMetrics.md index a6e8db242..546771767 100644 --- a/build/docs/JourneyViewResultMetrics.md +++ b/build/docs/JourneyViewResultMetrics.md @@ -15,4 +15,4 @@ The metrics of an element or a link in journey -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewSchedule.md b/build/docs/JourneyViewSchedule.md index 67b50be10..b460d1477 100644 --- a/build/docs/JourneyViewSchedule.md +++ b/build/docs/JourneyViewSchedule.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewScheduleListing.md b/build/docs/JourneyViewScheduleListing.md index 42dcd05c8..33c6a3e1f 100644 --- a/build/docs/JourneyViewScheduleListing.md +++ b/build/docs/JourneyViewScheduleListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyViewUser.md b/build/docs/JourneyViewUser.md index 29cb36f14..068817db6 100644 --- a/build/docs/JourneyViewUser.md +++ b/build/docs/JourneyViewUser.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationActionMap.md b/build/docs/JourneyWebActionEventsNotificationActionMap.md index 3d42e1f76..8924966f8 100644 --- a/build/docs/JourneyWebActionEventsNotificationActionMap.md +++ b/build/docs/JourneyWebActionEventsNotificationActionMap.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationActionMapPageUrlCondition.md b/build/docs/JourneyWebActionEventsNotificationActionMapPageUrlCondition.md index a836e0a96..f02b8cd0a 100644 --- a/build/docs/JourneyWebActionEventsNotificationActionMapPageUrlCondition.md +++ b/build/docs/JourneyWebActionEventsNotificationActionMapPageUrlCondition.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationActionTarget.md b/build/docs/JourneyWebActionEventsNotificationActionTarget.md index 83c164086..5f4a51717 100644 --- a/build/docs/JourneyWebActionEventsNotificationActionTarget.md +++ b/build/docs/JourneyWebActionEventsNotificationActionTarget.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationBlockedWebActionOfferMessage.md b/build/docs/JourneyWebActionEventsNotificationBlockedWebActionOfferMessage.md index de50aa903..bd0c0df4f 100644 --- a/build/docs/JourneyWebActionEventsNotificationBlockedWebActionOfferMessage.md +++ b/build/docs/JourneyWebActionEventsNotificationBlockedWebActionOfferMessage.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationBrowser.md b/build/docs/JourneyWebActionEventsNotificationBrowser.md index bf2c2baa9..4d53ce789 100644 --- a/build/docs/JourneyWebActionEventsNotificationBrowser.md +++ b/build/docs/JourneyWebActionEventsNotificationBrowser.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationDevice.md b/build/docs/JourneyWebActionEventsNotificationDevice.md index 3179d445d..467020323 100644 --- a/build/docs/JourneyWebActionEventsNotificationDevice.md +++ b/build/docs/JourneyWebActionEventsNotificationDevice.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationEmergencyGroup.md b/build/docs/JourneyWebActionEventsNotificationEmergencyGroup.md index bca21c1e3..0e2f8e1fc 100644 --- a/build/docs/JourneyWebActionEventsNotificationEmergencyGroup.md +++ b/build/docs/JourneyWebActionEventsNotificationEmergencyGroup.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationEventAction.md b/build/docs/JourneyWebActionEventsNotificationEventAction.md index eabf37afb..efddc61dc 100644 --- a/build/docs/JourneyWebActionEventsNotificationEventAction.md +++ b/build/docs/JourneyWebActionEventsNotificationEventAction.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationExternalContact.md b/build/docs/JourneyWebActionEventsNotificationExternalContact.md index d9ff35998..b8dbcc193 100644 --- a/build/docs/JourneyWebActionEventsNotificationExternalContact.md +++ b/build/docs/JourneyWebActionEventsNotificationExternalContact.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationGeoLocation.md b/build/docs/JourneyWebActionEventsNotificationGeoLocation.md index bc244ccaa..a341e42a6 100644 --- a/build/docs/JourneyWebActionEventsNotificationGeoLocation.md +++ b/build/docs/JourneyWebActionEventsNotificationGeoLocation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationMktCampaign.md b/build/docs/JourneyWebActionEventsNotificationMktCampaign.md index 66eab6bb8..2f2f17e08 100644 --- a/build/docs/JourneyWebActionEventsNotificationMktCampaign.md +++ b/build/docs/JourneyWebActionEventsNotificationMktCampaign.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationReferrer.md b/build/docs/JourneyWebActionEventsNotificationReferrer.md index 642b81ce8..8602476ea 100644 --- a/build/docs/JourneyWebActionEventsNotificationReferrer.md +++ b/build/docs/JourneyWebActionEventsNotificationReferrer.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationScheduleGroup.md b/build/docs/JourneyWebActionEventsNotificationScheduleGroup.md index daac541f6..54a593537 100644 --- a/build/docs/JourneyWebActionEventsNotificationScheduleGroup.md +++ b/build/docs/JourneyWebActionEventsNotificationScheduleGroup.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationSession.md b/build/docs/JourneyWebActionEventsNotificationSession.md index e8d7a9aa1..399b6cb7b 100644 --- a/build/docs/JourneyWebActionEventsNotificationSession.md +++ b/build/docs/JourneyWebActionEventsNotificationSession.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationWebActionEventsNotification.md b/build/docs/JourneyWebActionEventsNotificationWebActionEventsNotification.md index 6455167a3..0d8c66dcf 100644 --- a/build/docs/JourneyWebActionEventsNotificationWebActionEventsNotification.md +++ b/build/docs/JourneyWebActionEventsNotificationWebActionEventsNotification.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebActionEventsNotificationWebActionMessage.md b/build/docs/JourneyWebActionEventsNotificationWebActionMessage.md index ff321d36b..3174a6315 100644 --- a/build/docs/JourneyWebActionEventsNotificationWebActionMessage.md +++ b/build/docs/JourneyWebActionEventsNotificationWebActionMessage.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationActionMap.md b/build/docs/JourneyWebEventsNotificationActionMap.md index b99b09b61..f8e7efe9e 100644 --- a/build/docs/JourneyWebEventsNotificationActionMap.md +++ b/build/docs/JourneyWebEventsNotificationActionMap.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationActionTarget.md b/build/docs/JourneyWebEventsNotificationActionTarget.md index cbc10ff89..a2f8d6d03 100644 --- a/build/docs/JourneyWebEventsNotificationActionTarget.md +++ b/build/docs/JourneyWebEventsNotificationActionTarget.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationAssociatedValue.md b/build/docs/JourneyWebEventsNotificationAssociatedValue.md index 15cf87a02..3515ed57c 100644 --- a/build/docs/JourneyWebEventsNotificationAssociatedValue.md +++ b/build/docs/JourneyWebEventsNotificationAssociatedValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationBrowser.md b/build/docs/JourneyWebEventsNotificationBrowser.md index d1ed4dd37..ece6b1e4d 100644 --- a/build/docs/JourneyWebEventsNotificationBrowser.md +++ b/build/docs/JourneyWebEventsNotificationBrowser.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationCustomEventAttribute.md b/build/docs/JourneyWebEventsNotificationCustomEventAttribute.md index 52d8fac9a..59cd15ea3 100644 --- a/build/docs/JourneyWebEventsNotificationCustomEventAttribute.md +++ b/build/docs/JourneyWebEventsNotificationCustomEventAttribute.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationDevice.md b/build/docs/JourneyWebEventsNotificationDevice.md index e63ca51e6..2878dfc8a 100644 --- a/build/docs/JourneyWebEventsNotificationDevice.md +++ b/build/docs/JourneyWebEventsNotificationDevice.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationEventAction.md b/build/docs/JourneyWebEventsNotificationEventAction.md index 06d6e23b3..e2855f769 100644 --- a/build/docs/JourneyWebEventsNotificationEventAction.md +++ b/build/docs/JourneyWebEventsNotificationEventAction.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationExternalContact.md b/build/docs/JourneyWebEventsNotificationExternalContact.md index 9da10c6f8..cbe0358b2 100644 --- a/build/docs/JourneyWebEventsNotificationExternalContact.md +++ b/build/docs/JourneyWebEventsNotificationExternalContact.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationGeoLocation.md b/build/docs/JourneyWebEventsNotificationGeoLocation.md index cf1123bdc..442ea2f1b 100644 --- a/build/docs/JourneyWebEventsNotificationGeoLocation.md +++ b/build/docs/JourneyWebEventsNotificationGeoLocation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationMktCampaign.md b/build/docs/JourneyWebEventsNotificationMktCampaign.md index 8f8effbdd..e1c12f5b9 100644 --- a/build/docs/JourneyWebEventsNotificationMktCampaign.md +++ b/build/docs/JourneyWebEventsNotificationMktCampaign.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationOutcome.md b/build/docs/JourneyWebEventsNotificationOutcome.md index 2cb795f0c..943c30109 100644 --- a/build/docs/JourneyWebEventsNotificationOutcome.md +++ b/build/docs/JourneyWebEventsNotificationOutcome.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationOutcomeAchievedMessage.md b/build/docs/JourneyWebEventsNotificationOutcomeAchievedMessage.md index 57f1464c9..8eb624926 100644 --- a/build/docs/JourneyWebEventsNotificationOutcomeAchievedMessage.md +++ b/build/docs/JourneyWebEventsNotificationOutcomeAchievedMessage.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationPage.md b/build/docs/JourneyWebEventsNotificationPage.md index dca99f89b..c87da3385 100644 --- a/build/docs/JourneyWebEventsNotificationPage.md +++ b/build/docs/JourneyWebEventsNotificationPage.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationReferrer.md b/build/docs/JourneyWebEventsNotificationReferrer.md index e03669e2d..b7d67c378 100644 --- a/build/docs/JourneyWebEventsNotificationReferrer.md +++ b/build/docs/JourneyWebEventsNotificationReferrer.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationSegment.md b/build/docs/JourneyWebEventsNotificationSegment.md index b40ce53ce..d7391a61f 100644 --- a/build/docs/JourneyWebEventsNotificationSegment.md +++ b/build/docs/JourneyWebEventsNotificationSegment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationSegmentAssignmentMessage.md b/build/docs/JourneyWebEventsNotificationSegmentAssignmentMessage.md index b7feed61b..b57377b30 100644 --- a/build/docs/JourneyWebEventsNotificationSegmentAssignmentMessage.md +++ b/build/docs/JourneyWebEventsNotificationSegmentAssignmentMessage.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationSession.md b/build/docs/JourneyWebEventsNotificationSession.md index 5212cb5fc..4178ec77b 100644 --- a/build/docs/JourneyWebEventsNotificationSession.md +++ b/build/docs/JourneyWebEventsNotificationSession.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationWebActionMessage.md b/build/docs/JourneyWebEventsNotificationWebActionMessage.md index 93b5b3c3a..229cc7b9c 100644 --- a/build/docs/JourneyWebEventsNotificationWebActionMessage.md +++ b/build/docs/JourneyWebEventsNotificationWebActionMessage.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationWebEventsNotification.md b/build/docs/JourneyWebEventsNotificationWebEventsNotification.md index 193a4feba..98683dfaf 100644 --- a/build/docs/JourneyWebEventsNotificationWebEventsNotification.md +++ b/build/docs/JourneyWebEventsNotificationWebEventsNotification.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JourneyWebEventsNotificationWebMessage.md b/build/docs/JourneyWebEventsNotificationWebMessage.md index 6eb2d85c7..86df13b32 100644 --- a/build/docs/JourneyWebEventsNotificationWebMessage.md +++ b/build/docs/JourneyWebEventsNotificationWebMessage.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JsonCursorSearchResponse.md b/build/docs/JsonCursorSearchResponse.md index 6901cf89c..dffd92ab1 100644 --- a/build/docs/JsonCursorSearchResponse.md +++ b/build/docs/JsonCursorSearchResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JsonNode.md b/build/docs/JsonNode.md index d8b521c87..a17dc97b7 100644 --- a/build/docs/JsonNode.md +++ b/build/docs/JsonNode.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JsonNodeSearchResponse.md b/build/docs/JsonNodeSearchResponse.md index 2d0bb5433..9d908581d 100644 --- a/build/docs/JsonNodeSearchResponse.md +++ b/build/docs/JsonNodeSearchResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JsonSchemaDocument.md b/build/docs/JsonSchemaDocument.md index 3e946aa47..44988a05c 100644 --- a/build/docs/JsonSchemaDocument.md +++ b/build/docs/JsonSchemaDocument.md @@ -18,4 +18,4 @@ A JSON Schema document. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/JsonSearchResponse.md b/build/docs/JsonSearchResponse.md index af1efffa2..b3884991f 100644 --- a/build/docs/JsonSearchResponse.md +++ b/build/docs/JsonSearchResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KeyPerformanceIndicator.md b/build/docs/KeyPerformanceIndicator.md index e024521a9..f91ea8a92 100644 --- a/build/docs/KeyPerformanceIndicator.md +++ b/build/docs/KeyPerformanceIndicator.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KeyPerformanceIndicatorAssessment.md b/build/docs/KeyPerformanceIndicatorAssessment.md index a3c081dea..149a90f28 100644 --- a/build/docs/KeyPerformanceIndicatorAssessment.md +++ b/build/docs/KeyPerformanceIndicatorAssessment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KeyRotationSchedule.md b/build/docs/KeyRotationSchedule.md index 714b813e5..0d688011d 100644 --- a/build/docs/KeyRotationSchedule.md +++ b/build/docs/KeyRotationSchedule.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KeyValue.md b/build/docs/KeyValue.md index a2940ea16..79e000f44 100644 --- a/build/docs/KeyValue.md +++ b/build/docs/KeyValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KlaxonHeartBeatAlertsTopicHeartBeatAlert.md b/build/docs/KlaxonHeartBeatAlertsTopicHeartBeatAlert.md index cb02e1210..5e3614408 100644 --- a/build/docs/KlaxonHeartBeatAlertsTopicHeartBeatAlert.md +++ b/build/docs/KlaxonHeartBeatAlertsTopicHeartBeatAlert.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KlaxonHeartBeatAlertsTopicNotificationUser.md b/build/docs/KlaxonHeartBeatAlertsTopicNotificationUser.md index c6f1c40e7..04fb8cd03 100644 --- a/build/docs/KlaxonHeartBeatAlertsTopicNotificationUser.md +++ b/build/docs/KlaxonHeartBeatAlertsTopicNotificationUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KlaxonHeartBeatRulesTopicHeartBeatRule.md b/build/docs/KlaxonHeartBeatRulesTopicHeartBeatRule.md index d67df8ab1..72bcf66f3 100644 --- a/build/docs/KlaxonHeartBeatRulesTopicHeartBeatRule.md +++ b/build/docs/KlaxonHeartBeatRulesTopicHeartBeatRule.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KlaxonHeartBeatRulesTopicNotificationUser.md b/build/docs/KlaxonHeartBeatRulesTopicNotificationUser.md index 628de7c84..079361537 100644 --- a/build/docs/KlaxonHeartBeatRulesTopicNotificationUser.md +++ b/build/docs/KlaxonHeartBeatRulesTopicNotificationUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KlaxonInteractionStatsAlertsTopicInteractionStatAlert.md b/build/docs/KlaxonInteractionStatsAlertsTopicInteractionStatAlert.md index a771a9be8..6bfc8572c 100644 --- a/build/docs/KlaxonInteractionStatsAlertsTopicInteractionStatAlert.md +++ b/build/docs/KlaxonInteractionStatsAlertsTopicInteractionStatAlert.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KlaxonInteractionStatsAlertsTopicNotificationUser.md b/build/docs/KlaxonInteractionStatsAlertsTopicNotificationUser.md index 8604b191f..4ff4b1614 100644 --- a/build/docs/KlaxonInteractionStatsAlertsTopicNotificationUser.md +++ b/build/docs/KlaxonInteractionStatsAlertsTopicNotificationUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KlaxonInteractionStatsRulesTopicInteractionStatRule.md b/build/docs/KlaxonInteractionStatsRulesTopicInteractionStatRule.md index 604d99608..363e8dc41 100644 --- a/build/docs/KlaxonInteractionStatsRulesTopicInteractionStatRule.md +++ b/build/docs/KlaxonInteractionStatsRulesTopicInteractionStatRule.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KlaxonInteractionStatsRulesTopicNotificationUser.md b/build/docs/KlaxonInteractionStatsRulesTopicNotificationUser.md index 5650a5448..62c52e340 100644 --- a/build/docs/KlaxonInteractionStatsRulesTopicNotificationUser.md +++ b/build/docs/KlaxonInteractionStatsRulesTopicNotificationUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Knowledge.md b/build/docs/Knowledge.md index 2bcea6d4a..0d85076d3 100644 --- a/build/docs/Knowledge.md +++ b/build/docs/Knowledge.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAPI.md b/build/docs/KnowledgeAPI.md index 6b79b0989..c42b6875c 100644 --- a/build/docs/KnowledgeAPI.md +++ b/build/docs/KnowledgeAPI.md @@ -5798,4 +5798,4 @@ KnowledgeAPI.putKnowledgeKnowledgebaseSourcesServicenowSourceId(knowledgeBaseId: [**ServiceNowSourceResponse**](ServiceNowSourceResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAggregateDataContainer.md b/build/docs/KnowledgeAggregateDataContainer.md index 67680d7f5..761bc1c83 100644 --- a/build/docs/KnowledgeAggregateDataContainer.md +++ b/build/docs/KnowledgeAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAggregateQueryClause.md b/build/docs/KnowledgeAggregateQueryClause.md index ef2683c81..57793d23c 100644 --- a/build/docs/KnowledgeAggregateQueryClause.md +++ b/build/docs/KnowledgeAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAggregateQueryFilter.md b/build/docs/KnowledgeAggregateQueryFilter.md index b82b47e15..3b388481f 100644 --- a/build/docs/KnowledgeAggregateQueryFilter.md +++ b/build/docs/KnowledgeAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAggregateQueryPredicate.md b/build/docs/KnowledgeAggregateQueryPredicate.md index 8d0f94b33..2c5232336 100644 --- a/build/docs/KnowledgeAggregateQueryPredicate.md +++ b/build/docs/KnowledgeAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAggregateQueryResponse.md b/build/docs/KnowledgeAggregateQueryResponse.md index c3a506737..8a1946d8f 100644 --- a/build/docs/KnowledgeAggregateQueryResponse.md +++ b/build/docs/KnowledgeAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAggregationQuery.md b/build/docs/KnowledgeAggregationQuery.md index 8162a52b7..86a772f0d 100644 --- a/build/docs/KnowledgeAggregationQuery.md +++ b/build/docs/KnowledgeAggregationQuery.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAggregationView.md b/build/docs/KnowledgeAggregationView.md index 7868f39a0..ac398f6ff 100644 --- a/build/docs/KnowledgeAggregationView.md +++ b/build/docs/KnowledgeAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAnswerConfig.md b/build/docs/KnowledgeAnswerConfig.md index c47f82b37..7151004da 100644 --- a/build/docs/KnowledgeAnswerConfig.md +++ b/build/docs/KnowledgeAnswerConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAnswerDocumentResponse.md b/build/docs/KnowledgeAnswerDocumentResponse.md index 03c369032..6b164baaa 100644 --- a/build/docs/KnowledgeAnswerDocumentResponse.md +++ b/build/docs/KnowledgeAnswerDocumentResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAnswerDocumentsResponse.md b/build/docs/KnowledgeAnswerDocumentsResponse.md index d5dd241af..ba7741032 100644 --- a/build/docs/KnowledgeAnswerDocumentsResponse.md +++ b/build/docs/KnowledgeAnswerDocumentsResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeAnswerGenerationResponse.md b/build/docs/KnowledgeAnswerGenerationResponse.md index 96a025fcb..1719eea38 100644 --- a/build/docs/KnowledgeAnswerGenerationResponse.md +++ b/build/docs/KnowledgeAnswerGenerationResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeBase.md b/build/docs/KnowledgeBase.md index 4b330df62..522e4da46 100644 --- a/build/docs/KnowledgeBase.md +++ b/build/docs/KnowledgeBase.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeBaseCreateRequest.md b/build/docs/KnowledgeBaseCreateRequest.md index 20b949ad2..49f2f26b1 100644 --- a/build/docs/KnowledgeBaseCreateRequest.md +++ b/build/docs/KnowledgeBaseCreateRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeBaseListing.md b/build/docs/KnowledgeBaseListing.md index 2b4cbddb3..ec0a4eaef 100644 --- a/build/docs/KnowledgeBaseListing.md +++ b/build/docs/KnowledgeBaseListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeBaseReference.md b/build/docs/KnowledgeBaseReference.md index 3d21b4d1a..d5937bfa2 100644 --- a/build/docs/KnowledgeBaseReference.md +++ b/build/docs/KnowledgeBaseReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeBaseUpdateRequest.md b/build/docs/KnowledgeBaseUpdateRequest.md index eb6707f52..995b6b1e2 100644 --- a/build/docs/KnowledgeBaseUpdateRequest.md +++ b/build/docs/KnowledgeBaseUpdateRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeBaseWithDialectReference.md b/build/docs/KnowledgeBaseWithDialectReference.md index f2370615f..b4ea2f965 100644 --- a/build/docs/KnowledgeBaseWithDialectReference.md +++ b/build/docs/KnowledgeBaseWithDialectReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeCategory.md b/build/docs/KnowledgeCategory.md index f7f22afc3..737ac1ccc 100644 --- a/build/docs/KnowledgeCategory.md +++ b/build/docs/KnowledgeCategory.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeCategoryRequest.md b/build/docs/KnowledgeCategoryRequest.md index 074f0aee0..f5b926e46 100644 --- a/build/docs/KnowledgeCategoryRequest.md +++ b/build/docs/KnowledgeCategoryRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeContextReference.md b/build/docs/KnowledgeContextReference.md index ecb527f96..5ebffec47 100644 --- a/build/docs/KnowledgeContextReference.md +++ b/build/docs/KnowledgeContextReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeContextValueReference.md b/build/docs/KnowledgeContextValueReference.md index 417f732b9..867c57cce 100644 --- a/build/docs/KnowledgeContextValueReference.md +++ b/build/docs/KnowledgeContextValueReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeConversationContext.md b/build/docs/KnowledgeConversationContext.md index 320a9b8ba..e2a3ed566 100644 --- a/build/docs/KnowledgeConversationContext.md +++ b/build/docs/KnowledgeConversationContext.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeConversationContextResponse.md b/build/docs/KnowledgeConversationContextResponse.md index e8ec987a6..c7748a1f7 100644 --- a/build/docs/KnowledgeConversationContextResponse.md +++ b/build/docs/KnowledgeConversationContextResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocument.md b/build/docs/KnowledgeDocument.md index 06647d860..3d8b8f553 100644 --- a/build/docs/KnowledgeDocument.md +++ b/build/docs/KnowledgeDocument.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentAlternative.md b/build/docs/KnowledgeDocumentAlternative.md index bdac1d3ce..7919166b6 100644 --- a/build/docs/KnowledgeDocumentAlternative.md +++ b/build/docs/KnowledgeDocumentAlternative.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentBulkRequest.md b/build/docs/KnowledgeDocumentBulkRequest.md index 0d4d64bf0..dcd6ff2de 100644 --- a/build/docs/KnowledgeDocumentBulkRequest.md +++ b/build/docs/KnowledgeDocumentBulkRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentCopy.md b/build/docs/KnowledgeDocumentCopy.md index 3a9402f3c..8307129f2 100644 --- a/build/docs/KnowledgeDocumentCopy.md +++ b/build/docs/KnowledgeDocumentCopy.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentCreateRequest.md b/build/docs/KnowledgeDocumentCreateRequest.md index 40e6fdda0..9bb58aa03 100644 --- a/build/docs/KnowledgeDocumentCreateRequest.md +++ b/build/docs/KnowledgeDocumentCreateRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentDescriptor.md b/build/docs/KnowledgeDocumentDescriptor.md index da4ecf9dd..03a25b158 100644 --- a/build/docs/KnowledgeDocumentDescriptor.md +++ b/build/docs/KnowledgeDocumentDescriptor.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentFeedback.md b/build/docs/KnowledgeDocumentFeedback.md index 1a47cc517..68f6e6ca8 100644 --- a/build/docs/KnowledgeDocumentFeedback.md +++ b/build/docs/KnowledgeDocumentFeedback.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentFeedbackResponse.md b/build/docs/KnowledgeDocumentFeedbackResponse.md index 2f6855784..a3159b6d9 100644 --- a/build/docs/KnowledgeDocumentFeedbackResponse.md +++ b/build/docs/KnowledgeDocumentFeedbackResponse.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentFeedbackResponseListing.md b/build/docs/KnowledgeDocumentFeedbackResponseListing.md index fa9e1167c..35ae9e6ae 100644 --- a/build/docs/KnowledgeDocumentFeedbackResponseListing.md +++ b/build/docs/KnowledgeDocumentFeedbackResponseListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentFeedbackUpdateRequest.md b/build/docs/KnowledgeDocumentFeedbackUpdateRequest.md index e912eb779..2bb923a04 100644 --- a/build/docs/KnowledgeDocumentFeedbackUpdateRequest.md +++ b/build/docs/KnowledgeDocumentFeedbackUpdateRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentGuestSearch.md b/build/docs/KnowledgeDocumentGuestSearch.md index 910e694fb..8284a8fed 100644 --- a/build/docs/KnowledgeDocumentGuestSearch.md +++ b/build/docs/KnowledgeDocumentGuestSearch.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentGuestSearchRequest.md b/build/docs/KnowledgeDocumentGuestSearchRequest.md index 222e77375..7c61afe2e 100644 --- a/build/docs/KnowledgeDocumentGuestSearchRequest.md +++ b/build/docs/KnowledgeDocumentGuestSearchRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentGuestSearchResult.md b/build/docs/KnowledgeDocumentGuestSearchResult.md index 292abfdf6..004d3df6b 100644 --- a/build/docs/KnowledgeDocumentGuestSearchResult.md +++ b/build/docs/KnowledgeDocumentGuestSearchResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentPresentation.md b/build/docs/KnowledgeDocumentPresentation.md index 3071a3e95..d1cc0510b 100644 --- a/build/docs/KnowledgeDocumentPresentation.md +++ b/build/docs/KnowledgeDocumentPresentation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentQuery.md b/build/docs/KnowledgeDocumentQuery.md index 887691943..874716266 100644 --- a/build/docs/KnowledgeDocumentQuery.md +++ b/build/docs/KnowledgeDocumentQuery.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentQueryResponse.md b/build/docs/KnowledgeDocumentQueryResponse.md index 65ae9a75e..690e9a5fe 100644 --- a/build/docs/KnowledgeDocumentQueryResponse.md +++ b/build/docs/KnowledgeDocumentQueryResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentReference.md b/build/docs/KnowledgeDocumentReference.md index b961192e5..2c5a90bd2 100644 --- a/build/docs/KnowledgeDocumentReference.md +++ b/build/docs/KnowledgeDocumentReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentReq.md b/build/docs/KnowledgeDocumentReq.md index f6443cc20..a6cd7dcc6 100644 --- a/build/docs/KnowledgeDocumentReq.md +++ b/build/docs/KnowledgeDocumentReq.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentRequest.md b/build/docs/KnowledgeDocumentRequest.md index 5d220ab76..fff077e9f 100644 --- a/build/docs/KnowledgeDocumentRequest.md +++ b/build/docs/KnowledgeDocumentRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentResponse.md b/build/docs/KnowledgeDocumentResponse.md index 291cc0689..1b3555e85 100644 --- a/build/docs/KnowledgeDocumentResponse.md +++ b/build/docs/KnowledgeDocumentResponse.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentResponseListing.md b/build/docs/KnowledgeDocumentResponseListing.md index a39ed1233..3e9667cbc 100644 --- a/build/docs/KnowledgeDocumentResponseListing.md +++ b/build/docs/KnowledgeDocumentResponseListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentSearch.md b/build/docs/KnowledgeDocumentSearch.md index 30a5d472f..99d8f3a24 100644 --- a/build/docs/KnowledgeDocumentSearch.md +++ b/build/docs/KnowledgeDocumentSearch.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentSearchRequest.md b/build/docs/KnowledgeDocumentSearchRequest.md index 97c3c796d..29eabda0a 100644 --- a/build/docs/KnowledgeDocumentSearchRequest.md +++ b/build/docs/KnowledgeDocumentSearchRequest.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentSearchResult.md b/build/docs/KnowledgeDocumentSearchResult.md index 9bc42efe0..78cbf0cfd 100644 --- a/build/docs/KnowledgeDocumentSearchResult.md +++ b/build/docs/KnowledgeDocumentSearchResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentSuggestion.md b/build/docs/KnowledgeDocumentSuggestion.md index a9f7efb0b..f99e11e9a 100644 --- a/build/docs/KnowledgeDocumentSuggestion.md +++ b/build/docs/KnowledgeDocumentSuggestion.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentSuggestionRequest.md b/build/docs/KnowledgeDocumentSuggestionRequest.md index 0022452c6..ea695995b 100644 --- a/build/docs/KnowledgeDocumentSuggestionRequest.md +++ b/build/docs/KnowledgeDocumentSuggestionRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentSuggestionResult.md b/build/docs/KnowledgeDocumentSuggestionResult.md index 9562f574c..767ddd9e6 100644 --- a/build/docs/KnowledgeDocumentSuggestionResult.md +++ b/build/docs/KnowledgeDocumentSuggestionResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentSuggestionResultDocument.md b/build/docs/KnowledgeDocumentSuggestionResultDocument.md index 25742f57d..f878706f3 100644 --- a/build/docs/KnowledgeDocumentSuggestionResultDocument.md +++ b/build/docs/KnowledgeDocumentSuggestionResultDocument.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentVersion.md b/build/docs/KnowledgeDocumentVersion.md index d6c1df32c..6f6bb85ee 100644 --- a/build/docs/KnowledgeDocumentVersion.md +++ b/build/docs/KnowledgeDocumentVersion.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentVersionListing.md b/build/docs/KnowledgeDocumentVersionListing.md index 5d4ad61a4..1e49d5865 100644 --- a/build/docs/KnowledgeDocumentVersionListing.md +++ b/build/docs/KnowledgeDocumentVersionListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentVersionReference.md b/build/docs/KnowledgeDocumentVersionReference.md index 5fc3c46d1..32b8adc19 100644 --- a/build/docs/KnowledgeDocumentVersionReference.md +++ b/build/docs/KnowledgeDocumentVersionReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentVersionVariation.md b/build/docs/KnowledgeDocumentVersionVariation.md index e0d1819e1..4f8196d6c 100644 --- a/build/docs/KnowledgeDocumentVersionVariation.md +++ b/build/docs/KnowledgeDocumentVersionVariation.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentVersionVariationListing.md b/build/docs/KnowledgeDocumentVersionVariationListing.md index c6c1b1175..143a6ebbb 100644 --- a/build/docs/KnowledgeDocumentVersionVariationListing.md +++ b/build/docs/KnowledgeDocumentVersionVariationListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentVersionVariationReference.md b/build/docs/KnowledgeDocumentVersionVariationReference.md index ac951d388..12557472c 100644 --- a/build/docs/KnowledgeDocumentVersionVariationReference.md +++ b/build/docs/KnowledgeDocumentVersionVariationReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentView.md b/build/docs/KnowledgeDocumentView.md index b44ec9460..8a14e8909 100644 --- a/build/docs/KnowledgeDocumentView.md +++ b/build/docs/KnowledgeDocumentView.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeDocumentsAnswerFilter.md b/build/docs/KnowledgeDocumentsAnswerFilter.md index 3d092cfff..ada575c09 100644 --- a/build/docs/KnowledgeDocumentsAnswerFilter.md +++ b/build/docs/KnowledgeDocumentsAnswerFilter.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeExportJobDocumentsFilter.md b/build/docs/KnowledgeExportJobDocumentsFilter.md index a9e4af990..ad6a878da 100644 --- a/build/docs/KnowledgeExportJobDocumentsFilter.md +++ b/build/docs/KnowledgeExportJobDocumentsFilter.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeExportJobFilter.md b/build/docs/KnowledgeExportJobFilter.md index 59d4c30fd..3724d12ce 100644 --- a/build/docs/KnowledgeExportJobFilter.md +++ b/build/docs/KnowledgeExportJobFilter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeExportJobRequest.md b/build/docs/KnowledgeExportJobRequest.md index 17696ee22..528969189 100644 --- a/build/docs/KnowledgeExportJobRequest.md +++ b/build/docs/KnowledgeExportJobRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeExportJobResponse.md b/build/docs/KnowledgeExportJobResponse.md index 4abb3db45..abe3d9866 100644 --- a/build/docs/KnowledgeExportJobResponse.md +++ b/build/docs/KnowledgeExportJobResponse.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeExtendedCategory.md b/build/docs/KnowledgeExtendedCategory.md index 765ef4755..55685d75d 100644 --- a/build/docs/KnowledgeExtendedCategory.md +++ b/build/docs/KnowledgeExtendedCategory.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGroupStatistics.md b/build/docs/KnowledgeGroupStatistics.md index 92567cdfd..1d1a1a554 100644 --- a/build/docs/KnowledgeGroupStatistics.md +++ b/build/docs/KnowledgeGroupStatistics.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestAnswerDocumentResponse.md b/build/docs/KnowledgeGuestAnswerDocumentResponse.md index a8eb35a4a..b1157053d 100644 --- a/build/docs/KnowledgeGuestAnswerDocumentResponse.md +++ b/build/docs/KnowledgeGuestAnswerDocumentResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestAnswerDocumentsResponse.md b/build/docs/KnowledgeGuestAnswerDocumentsResponse.md index ddedb9ae9..fa508851a 100644 --- a/build/docs/KnowledgeGuestAnswerDocumentsResponse.md +++ b/build/docs/KnowledgeGuestAnswerDocumentsResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentCopy.md b/build/docs/KnowledgeGuestDocumentCopy.md index 24aa869a6..9ac091b5f 100644 --- a/build/docs/KnowledgeGuestDocumentCopy.md +++ b/build/docs/KnowledgeGuestDocumentCopy.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentFeedback.md b/build/docs/KnowledgeGuestDocumentFeedback.md index 717c9bf89..b9cc0f4ff 100644 --- a/build/docs/KnowledgeGuestDocumentFeedback.md +++ b/build/docs/KnowledgeGuestDocumentFeedback.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentPresentation.md b/build/docs/KnowledgeGuestDocumentPresentation.md index 7821875d5..d4b9916d7 100644 --- a/build/docs/KnowledgeGuestDocumentPresentation.md +++ b/build/docs/KnowledgeGuestDocumentPresentation.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentResponse.md b/build/docs/KnowledgeGuestDocumentResponse.md index 94c840bb7..344ed0c6f 100644 --- a/build/docs/KnowledgeGuestDocumentResponse.md +++ b/build/docs/KnowledgeGuestDocumentResponse.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentResponseListing.md b/build/docs/KnowledgeGuestDocumentResponseListing.md index e064d568d..9dee3a14b 100644 --- a/build/docs/KnowledgeGuestDocumentResponseListing.md +++ b/build/docs/KnowledgeGuestDocumentResponseListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentSuggestion.md b/build/docs/KnowledgeGuestDocumentSuggestion.md index 97f9d7a4b..5609ed09c 100644 --- a/build/docs/KnowledgeGuestDocumentSuggestion.md +++ b/build/docs/KnowledgeGuestDocumentSuggestion.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentSuggestionRequest.md b/build/docs/KnowledgeGuestDocumentSuggestionRequest.md index 965c53444..174c30939 100644 --- a/build/docs/KnowledgeGuestDocumentSuggestionRequest.md +++ b/build/docs/KnowledgeGuestDocumentSuggestionRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentSuggestionResult.md b/build/docs/KnowledgeGuestDocumentSuggestionResult.md index 974874030..0bd77e2ff 100644 --- a/build/docs/KnowledgeGuestDocumentSuggestionResult.md +++ b/build/docs/KnowledgeGuestDocumentSuggestionResult.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentVariation.md b/build/docs/KnowledgeGuestDocumentVariation.md index 88cdd7fcc..226f8991e 100644 --- a/build/docs/KnowledgeGuestDocumentVariation.md +++ b/build/docs/KnowledgeGuestDocumentVariation.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentVariationAnswer.md b/build/docs/KnowledgeGuestDocumentVariationAnswer.md index b25557ec0..edeb41ee1 100644 --- a/build/docs/KnowledgeGuestDocumentVariationAnswer.md +++ b/build/docs/KnowledgeGuestDocumentVariationAnswer.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentVariationContext.md b/build/docs/KnowledgeGuestDocumentVariationContext.md index 4a7cef529..726393a89 100644 --- a/build/docs/KnowledgeGuestDocumentVariationContext.md +++ b/build/docs/KnowledgeGuestDocumentVariationContext.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentVersionReference.md b/build/docs/KnowledgeGuestDocumentVersionReference.md index ec0bdf83e..4082d6131 100644 --- a/build/docs/KnowledgeGuestDocumentVersionReference.md +++ b/build/docs/KnowledgeGuestDocumentVersionReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestDocumentView.md b/build/docs/KnowledgeGuestDocumentView.md index 1d15e9e73..e7afb29b9 100644 --- a/build/docs/KnowledgeGuestDocumentView.md +++ b/build/docs/KnowledgeGuestDocumentView.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestSearchClientApplication.md b/build/docs/KnowledgeGuestSearchClientApplication.md index fb2d0bd43..e04c30639 100644 --- a/build/docs/KnowledgeGuestSearchClientApplication.md +++ b/build/docs/KnowledgeGuestSearchClientApplication.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestSearchDocumentResponse.md b/build/docs/KnowledgeGuestSearchDocumentResponse.md index a0ec65056..cbe7956e4 100644 --- a/build/docs/KnowledgeGuestSearchDocumentResponse.md +++ b/build/docs/KnowledgeGuestSearchDocumentResponse.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestSession.md b/build/docs/KnowledgeGuestSession.md index 0e07ef322..a11fdc5e3 100644 --- a/build/docs/KnowledgeGuestSession.md +++ b/build/docs/KnowledgeGuestSession.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestSessionApp.md b/build/docs/KnowledgeGuestSessionApp.md index af4fc6512..1b0bcc2d4 100644 --- a/build/docs/KnowledgeGuestSessionApp.md +++ b/build/docs/KnowledgeGuestSessionApp.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeGuestSessionContext.md b/build/docs/KnowledgeGuestSessionContext.md index 20068aab9..45784e8a7 100644 --- a/build/docs/KnowledgeGuestSessionContext.md +++ b/build/docs/KnowledgeGuestSessionContext.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeImport.md b/build/docs/KnowledgeImport.md index 73247a1b2..0c22482bc 100644 --- a/build/docs/KnowledgeImport.md +++ b/build/docs/KnowledgeImport.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeImportJobError.md b/build/docs/KnowledgeImportJobError.md index ca4c65c93..ba8272938 100644 --- a/build/docs/KnowledgeImportJobError.md +++ b/build/docs/KnowledgeImportJobError.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeImportJobReport.md b/build/docs/KnowledgeImportJobReport.md index 54bf7d175..0b7dec436 100644 --- a/build/docs/KnowledgeImportJobReport.md +++ b/build/docs/KnowledgeImportJobReport.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeImportJobRequest.md b/build/docs/KnowledgeImportJobRequest.md index 0e63b7bb3..e50b9140b 100644 --- a/build/docs/KnowledgeImportJobRequest.md +++ b/build/docs/KnowledgeImportJobRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeImportJobResponse.md b/build/docs/KnowledgeImportJobResponse.md index 2cbc619db..b49f406e8 100644 --- a/build/docs/KnowledgeImportJobResponse.md +++ b/build/docs/KnowledgeImportJobResponse.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeImportJobSettings.md b/build/docs/KnowledgeImportJobSettings.md index 5f8832856..e218d325a 100644 --- a/build/docs/KnowledgeImportJobSettings.md +++ b/build/docs/KnowledgeImportJobSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeImportJobStatistics.md b/build/docs/KnowledgeImportJobStatistics.md index 038caa191..8456d2140 100644 --- a/build/docs/KnowledgeImportJobStatistics.md +++ b/build/docs/KnowledgeImportJobStatistics.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeIntegrationDefaultSettings.md b/build/docs/KnowledgeIntegrationDefaultSettings.md new file mode 100644 index 000000000..ca93e51ea --- /dev/null +++ b/build/docs/KnowledgeIntegrationDefaultSettings.md @@ -0,0 +1,13 @@ +# KnowledgeIntegrationDefaultSettings + +## KnowledgeIntegrationDefaultSettings + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **baseUrl** | **String** | The default base URL setting for the integration. | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeIntegrationFilter.md b/build/docs/KnowledgeIntegrationFilter.md index baedce6db..4ebc0eee8 100644 --- a/build/docs/KnowledgeIntegrationFilter.md +++ b/build/docs/KnowledgeIntegrationFilter.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeIntegrationFilterValue.md b/build/docs/KnowledgeIntegrationFilterValue.md index f6e1481d3..86038b9d0 100644 --- a/build/docs/KnowledgeIntegrationFilterValue.md +++ b/build/docs/KnowledgeIntegrationFilterValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeIntegrationOptionsResponse.md b/build/docs/KnowledgeIntegrationOptionsResponse.md index 59198d798..c0bdf6e82 100644 --- a/build/docs/KnowledgeIntegrationOptionsResponse.md +++ b/build/docs/KnowledgeIntegrationOptionsResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeIntegrationReference.md b/build/docs/KnowledgeIntegrationReference.md index 1a6641280..5431903f5 100644 --- a/build/docs/KnowledgeIntegrationReference.md +++ b/build/docs/KnowledgeIntegrationReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeOperationSource.md b/build/docs/KnowledgeOperationSource.md index d26ecefa6..5af78a9ac 100644 --- a/build/docs/KnowledgeOperationSource.md +++ b/build/docs/KnowledgeOperationSource.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSearchClientApplication.md b/build/docs/KnowledgeSearchClientApplication.md index ed037dbe1..0068efe63 100644 --- a/build/docs/KnowledgeSearchClientApplication.md +++ b/build/docs/KnowledgeSearchClientApplication.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSearchDocumentResponse.md b/build/docs/KnowledgeSearchDocumentResponse.md index d551a810f..366b6f752 100644 --- a/build/docs/KnowledgeSearchDocumentResponse.md +++ b/build/docs/KnowledgeSearchDocumentResponse.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSearchDocumentV1.md b/build/docs/KnowledgeSearchDocumentV1.md index a3838a23e..9d1f14f46 100644 --- a/build/docs/KnowledgeSearchDocumentV1.md +++ b/build/docs/KnowledgeSearchDocumentV1.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSearchRequest.md b/build/docs/KnowledgeSearchRequest.md index 427b02b0b..94f736e9e 100644 --- a/build/docs/KnowledgeSearchRequest.md +++ b/build/docs/KnowledgeSearchRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSearchResponse.md b/build/docs/KnowledgeSearchResponse.md index 77ea3aae0..c44297f56 100644 --- a/build/docs/KnowledgeSearchResponse.md +++ b/build/docs/KnowledgeSearchResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSuggestionConfig.md b/build/docs/KnowledgeSuggestionConfig.md index 80873a436..1e03ba6fc 100644 --- a/build/docs/KnowledgeSuggestionConfig.md +++ b/build/docs/KnowledgeSuggestionConfig.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSyncJobReport.md b/build/docs/KnowledgeSyncJobReport.md index 07c19293b..fbb0fe9a5 100644 --- a/build/docs/KnowledgeSyncJobReport.md +++ b/build/docs/KnowledgeSyncJobReport.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSyncJobRequest.md b/build/docs/KnowledgeSyncJobRequest.md index 8d60a3779..760e7bffe 100644 --- a/build/docs/KnowledgeSyncJobRequest.md +++ b/build/docs/KnowledgeSyncJobRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSyncJobResponse.md b/build/docs/KnowledgeSyncJobResponse.md index 0e7c56e47..92a34c0f8 100644 --- a/build/docs/KnowledgeSyncJobResponse.md +++ b/build/docs/KnowledgeSyncJobResponse.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeSyncJobStatistics.md b/build/docs/KnowledgeSyncJobStatistics.md index f2436a861..c6c98ac70 100644 --- a/build/docs/KnowledgeSyncJobStatistics.md +++ b/build/docs/KnowledgeSyncJobStatistics.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KnowledgeTraining.md b/build/docs/KnowledgeTraining.md index 741c8b703..9fd8b270b 100644 --- a/build/docs/KnowledgeTraining.md +++ b/build/docs/KnowledgeTraining.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/KpiResult.md b/build/docs/KpiResult.md index 046c35bee..ce24a0f18 100644 --- a/build/docs/KpiResult.md +++ b/build/docs/KpiResult.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Label.md b/build/docs/Label.md index 95b877081..7bd324c03 100644 --- a/build/docs/Label.md +++ b/build/docs/Label.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LabelCreateRequest.md b/build/docs/LabelCreateRequest.md index c60bd6292..dc5d6397c 100644 --- a/build/docs/LabelCreateRequest.md +++ b/build/docs/LabelCreateRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LabelEntity.md b/build/docs/LabelEntity.md index df1aef3c6..2e083b251 100644 --- a/build/docs/LabelEntity.md +++ b/build/docs/LabelEntity.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LabelListing.md b/build/docs/LabelListing.md index a7e283f44..a2297435b 100644 --- a/build/docs/LabelListing.md +++ b/build/docs/LabelListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LabelResponse.md b/build/docs/LabelResponse.md index 6c7a3f5cb..6adcab384 100644 --- a/build/docs/LabelResponse.md +++ b/build/docs/LabelResponse.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LabelUpdateRequest.md b/build/docs/LabelUpdateRequest.md index 41fc1e462..05ec4641b 100644 --- a/build/docs/LabelUpdateRequest.md +++ b/build/docs/LabelUpdateRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LabelUtilizationRequest.md b/build/docs/LabelUtilizationRequest.md index af09a6fd1..564ca68d4 100644 --- a/build/docs/LabelUtilizationRequest.md +++ b/build/docs/LabelUtilizationRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LabelUtilizationResponse.md b/build/docs/LabelUtilizationResponse.md index a7eb2583d..848bac075 100644 --- a/build/docs/LabelUtilizationResponse.md +++ b/build/docs/LabelUtilizationResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LabelsFilter.md b/build/docs/LabelsFilter.md index 0666b8100..6e431f27f 100644 --- a/build/docs/LabelsFilter.md +++ b/build/docs/LabelsFilter.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Language.md b/build/docs/Language.md index 925255b65..b8f6ea2a2 100644 --- a/build/docs/Language.md +++ b/build/docs/Language.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LanguageEntityListing.md b/build/docs/LanguageEntityListing.md index b2534c046..0041d337d 100644 --- a/build/docs/LanguageEntityListing.md +++ b/build/docs/LanguageEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LanguageOverride.md b/build/docs/LanguageOverride.md index 2090c9b50..9f06192c7 100644 --- a/build/docs/LanguageOverride.md +++ b/build/docs/LanguageOverride.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LanguageReference.md b/build/docs/LanguageReference.md index 7b63fadce..47587ba7f 100644 --- a/build/docs/LanguageReference.md +++ b/build/docs/LanguageReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LanguageUnderstandingAPI.md b/build/docs/LanguageUnderstandingAPI.md index 832987c31..08c8305bb 100644 --- a/build/docs/LanguageUnderstandingAPI.md +++ b/build/docs/LanguageUnderstandingAPI.md @@ -1799,4 +1799,4 @@ LanguageUnderstandingAPI.putLanguageunderstandingDomainVersion(domainId: domainI [**NluDomainVersion**](NluDomainVersion) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LanguagesAPI.md b/build/docs/LanguagesAPI.md index 7cb958cd5..032f1ad7c 100644 --- a/build/docs/LanguagesAPI.md +++ b/build/docs/LanguagesAPI.md @@ -420,4 +420,4 @@ LanguagesAPI.postLanguages(body: body) { (response, error) in [**Language**](Language) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LastAttemptByColumnConditionSettings.md b/build/docs/LastAttemptByColumnConditionSettings.md index 298e6d2b5..5d886cf26 100644 --- a/build/docs/LastAttemptByColumnConditionSettings.md +++ b/build/docs/LastAttemptByColumnConditionSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LastAttemptOverallConditionSettings.md b/build/docs/LastAttemptOverallConditionSettings.md index b9556213c..6b99f9061 100644 --- a/build/docs/LastAttemptOverallConditionSettings.md +++ b/build/docs/LastAttemptOverallConditionSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LastResultByColumnConditionSettings.md b/build/docs/LastResultByColumnConditionSettings.md index 594328d46..9f2be76b5 100644 --- a/build/docs/LastResultByColumnConditionSettings.md +++ b/build/docs/LastResultByColumnConditionSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LastResultOverallConditionSettings.md b/build/docs/LastResultOverallConditionSettings.md index fb7eaf340..a1d3580ab 100644 --- a/build/docs/LastResultOverallConditionSettings.md +++ b/build/docs/LastResultOverallConditionSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LauncherButtonSettings.md b/build/docs/LauncherButtonSettings.md index e20132bfb..167047081 100644 --- a/build/docs/LauncherButtonSettings.md +++ b/build/docs/LauncherButtonSettings.md @@ -11,4 +11,4 @@ The settings for the launcher button -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Leaderboard.md b/build/docs/Leaderboard.md index eff5c1f9d..3cf0e2149 100644 --- a/build/docs/Leaderboard.md +++ b/build/docs/Leaderboard.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LeaderboardItem.md b/build/docs/LeaderboardItem.md index 2db9bae66..3cade7ae9 100644 --- a/build/docs/LeaderboardItem.md +++ b/build/docs/LeaderboardItem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAPI.md b/build/docs/LearningAPI.md index 6c14dc16f..a19a0fcfe 100644 --- a/build/docs/LearningAPI.md +++ b/build/docs/LearningAPI.md @@ -1947,4 +1947,4 @@ LearningAPI.putLearningModuleRule(moduleId: moduleId, body: body) { (response, e [**LearningModuleRule**](LearningModuleRule) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssessment.md b/build/docs/LearningAssessment.md index 7ac45e20a..2e31d624f 100644 --- a/build/docs/LearningAssessment.md +++ b/build/docs/LearningAssessment.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssessmentScoringRequest.md b/build/docs/LearningAssessmentScoringRequest.md index 6e22dfcc0..527d35ce4 100644 --- a/build/docs/LearningAssessmentScoringRequest.md +++ b/build/docs/LearningAssessmentScoringRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignment.md b/build/docs/LearningAssignment.md index 28519595d..1605ee0bd 100644 --- a/build/docs/LearningAssignment.md +++ b/build/docs/LearningAssignment.md @@ -35,4 +35,4 @@ Learning module assignment with user information -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateParam.md b/build/docs/LearningAssignmentAggregateParam.md index 4462f6958..0627e8157 100644 --- a/build/docs/LearningAssignmentAggregateParam.md +++ b/build/docs/LearningAssignmentAggregateParam.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateQueryRequestClause.md b/build/docs/LearningAssignmentAggregateQueryRequestClause.md index 372d8dc33..50a6db238 100644 --- a/build/docs/LearningAssignmentAggregateQueryRequestClause.md +++ b/build/docs/LearningAssignmentAggregateQueryRequestClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateQueryRequestFilter.md b/build/docs/LearningAssignmentAggregateQueryRequestFilter.md index c51174111..71136fe4c 100644 --- a/build/docs/LearningAssignmentAggregateQueryRequestFilter.md +++ b/build/docs/LearningAssignmentAggregateQueryRequestFilter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateQueryRequestPredicate.md b/build/docs/LearningAssignmentAggregateQueryRequestPredicate.md index 53cdd9183..772797878 100644 --- a/build/docs/LearningAssignmentAggregateQueryRequestPredicate.md +++ b/build/docs/LearningAssignmentAggregateQueryRequestPredicate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateQueryResponseData.md b/build/docs/LearningAssignmentAggregateQueryResponseData.md index 60eba493f..7839e9e6a 100644 --- a/build/docs/LearningAssignmentAggregateQueryResponseData.md +++ b/build/docs/LearningAssignmentAggregateQueryResponseData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateQueryResponseGroupedData.md b/build/docs/LearningAssignmentAggregateQueryResponseGroupedData.md index c9842da32..d67c81006 100644 --- a/build/docs/LearningAssignmentAggregateQueryResponseGroupedData.md +++ b/build/docs/LearningAssignmentAggregateQueryResponseGroupedData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateQueryResponseMetric.md b/build/docs/LearningAssignmentAggregateQueryResponseMetric.md index ba6cc117e..426209c80 100644 --- a/build/docs/LearningAssignmentAggregateQueryResponseMetric.md +++ b/build/docs/LearningAssignmentAggregateQueryResponseMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateQueryResponseStats.md b/build/docs/LearningAssignmentAggregateQueryResponseStats.md index fcab26650..500e83272 100644 --- a/build/docs/LearningAssignmentAggregateQueryResponseStats.md +++ b/build/docs/LearningAssignmentAggregateQueryResponseStats.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentAggregateResponse.md b/build/docs/LearningAssignmentAggregateResponse.md index 68ac356e0..f9ced9a99 100644 --- a/build/docs/LearningAssignmentAggregateResponse.md +++ b/build/docs/LearningAssignmentAggregateResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentBulkAddResponse.md b/build/docs/LearningAssignmentBulkAddResponse.md index c5d174e3d..45ea471e1 100644 --- a/build/docs/LearningAssignmentBulkAddResponse.md +++ b/build/docs/LearningAssignmentBulkAddResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentBulkRemoveResponse.md b/build/docs/LearningAssignmentBulkRemoveResponse.md index 2caea4b5a..36304f542 100644 --- a/build/docs/LearningAssignmentBulkRemoveResponse.md +++ b/build/docs/LearningAssignmentBulkRemoveResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentCreate.md b/build/docs/LearningAssignmentCreate.md index bec9d6cab..972d3be01 100644 --- a/build/docs/LearningAssignmentCreate.md +++ b/build/docs/LearningAssignmentCreate.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentEntity.md b/build/docs/LearningAssignmentEntity.md index 419e90c11..793d1a7c9 100644 --- a/build/docs/LearningAssignmentEntity.md +++ b/build/docs/LearningAssignmentEntity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentExternalUpdate.md b/build/docs/LearningAssignmentExternalUpdate.md index ee1e0e804..7345fc193 100644 --- a/build/docs/LearningAssignmentExternalUpdate.md +++ b/build/docs/LearningAssignmentExternalUpdate.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentItem.md b/build/docs/LearningAssignmentItem.md index 2b6b48bc9..a37d49830 100644 --- a/build/docs/LearningAssignmentItem.md +++ b/build/docs/LearningAssignmentItem.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentReassign.md b/build/docs/LearningAssignmentReassign.md index 770f40e28..03fc517e6 100644 --- a/build/docs/LearningAssignmentReassign.md +++ b/build/docs/LearningAssignmentReassign.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentReference.md b/build/docs/LearningAssignmentReference.md index cf38babdc..3a10490ea 100644 --- a/build/docs/LearningAssignmentReference.md +++ b/build/docs/LearningAssignmentReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentReschedule.md b/build/docs/LearningAssignmentReschedule.md index 9e5c98029..968b29e5e 100644 --- a/build/docs/LearningAssignmentReschedule.md +++ b/build/docs/LearningAssignmentReschedule.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md b/build/docs/LearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md index a0c9e9173..abf6aa9d9 100644 --- a/build/docs/LearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md +++ b/build/docs/LearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentRuleRunTopicLearningAssignmentsCreated.md b/build/docs/LearningAssignmentRuleRunTopicLearningAssignmentsCreated.md index 14129ecba..66bbb0d62 100644 --- a/build/docs/LearningAssignmentRuleRunTopicLearningAssignmentsCreated.md +++ b/build/docs/LearningAssignmentRuleRunTopicLearningAssignmentsCreated.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentRuleRunTopicLearningModuleReference.md b/build/docs/LearningAssignmentRuleRunTopicLearningModuleReference.md index f319ae325..4a75ae378 100644 --- a/build/docs/LearningAssignmentRuleRunTopicLearningModuleReference.md +++ b/build/docs/LearningAssignmentRuleRunTopicLearningModuleReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentStep.md b/build/docs/LearningAssignmentStep.md index 956f5cddd..58f18a603 100644 --- a/build/docs/LearningAssignmentStep.md +++ b/build/docs/LearningAssignmentStep.md @@ -20,4 +20,4 @@ Learning assignment step -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentStepScoStructure.md b/build/docs/LearningAssignmentStepScoStructure.md index 4e4f0491b..b56a6b319 100644 --- a/build/docs/LearningAssignmentStepScoStructure.md +++ b/build/docs/LearningAssignmentStepScoStructure.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentStepSignedCookie.md b/build/docs/LearningAssignmentStepSignedCookie.md index 216c724c1..35dba5df2 100644 --- a/build/docs/LearningAssignmentStepSignedCookie.md +++ b/build/docs/LearningAssignmentStepSignedCookie.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentTopicLearningAssignmentNotification.md b/build/docs/LearningAssignmentTopicLearningAssignmentNotification.md index b68f4dbfc..d66fbb34c 100644 --- a/build/docs/LearningAssignmentTopicLearningAssignmentNotification.md +++ b/build/docs/LearningAssignmentTopicLearningAssignmentNotification.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentTopicLearningModuleReference.md b/build/docs/LearningAssignmentTopicLearningModuleReference.md index 355b82f07..73c186d85 100644 --- a/build/docs/LearningAssignmentTopicLearningModuleReference.md +++ b/build/docs/LearningAssignmentTopicLearningModuleReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentTopicUserReference.md b/build/docs/LearningAssignmentTopicUserReference.md index 4fb819033..ad019553e 100644 --- a/build/docs/LearningAssignmentTopicUserReference.md +++ b/build/docs/LearningAssignmentTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentUpdate.md b/build/docs/LearningAssignmentUpdate.md index 7e5b5f73f..b20a4f67f 100644 --- a/build/docs/LearningAssignmentUpdate.md +++ b/build/docs/LearningAssignmentUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentUser.md b/build/docs/LearningAssignmentUser.md index 9ba348512..adc305769 100644 --- a/build/docs/LearningAssignmentUser.md +++ b/build/docs/LearningAssignmentUser.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentUserListing.md b/build/docs/LearningAssignmentUserListing.md index c10b22ff6..572ab635e 100644 --- a/build/docs/LearningAssignmentUserListing.md +++ b/build/docs/LearningAssignmentUserListing.md @@ -12,13 +12,13 @@ List of users matching the learning module rule | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | The number of users matching search term | [optional] | | **unfilteredTotal** | **Int** | The total number of users | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentUserQuery.md b/build/docs/LearningAssignmentUserQuery.md index 4d7821963..c746b2e13 100644 --- a/build/docs/LearningAssignmentUserQuery.md +++ b/build/docs/LearningAssignmentUserQuery.md @@ -12,4 +12,4 @@ Learning module users query request model -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningAssignmentsDomainEntity.md b/build/docs/LearningAssignmentsDomainEntity.md index c8a2c8bec..f935c2fb4 100644 --- a/build/docs/LearningAssignmentsDomainEntity.md +++ b/build/docs/LearningAssignmentsDomainEntity.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningCoverArtThumbnail.md b/build/docs/LearningCoverArtThumbnail.md index 8f4e5df91..e6ed6644e 100644 --- a/build/docs/LearningCoverArtThumbnail.md +++ b/build/docs/LearningCoverArtThumbnail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningCoverArtUploadUrlRequest.md b/build/docs/LearningCoverArtUploadUrlRequest.md index 6e573957d..087ee99f5 100644 --- a/build/docs/LearningCoverArtUploadUrlRequest.md +++ b/build/docs/LearningCoverArtUploadUrlRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModule.md b/build/docs/LearningModule.md index 80ebcaa71..730d5863d 100644 --- a/build/docs/LearningModule.md +++ b/build/docs/LearningModule.md @@ -36,4 +36,4 @@ Learning module response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleCoverArtRequest.md b/build/docs/LearningModuleCoverArtRequest.md index 0846bb923..c782f8ed5 100644 --- a/build/docs/LearningModuleCoverArtRequest.md +++ b/build/docs/LearningModuleCoverArtRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleCoverArtResponse.md b/build/docs/LearningModuleCoverArtResponse.md index e9d59059f..017b52679 100644 --- a/build/docs/LearningModuleCoverArtResponse.md +++ b/build/docs/LearningModuleCoverArtResponse.md @@ -14,4 +14,4 @@ Learning module cover art response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleInformStep.md b/build/docs/LearningModuleInformStep.md index d27aa2bc1..34c74d884 100644 --- a/build/docs/LearningModuleInformStep.md +++ b/build/docs/LearningModuleInformStep.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleInformStepRequest.md b/build/docs/LearningModuleInformStepRequest.md index d30713e0e..6dcedaf16 100644 --- a/build/docs/LearningModuleInformStepRequest.md +++ b/build/docs/LearningModuleInformStepRequest.md @@ -18,4 +18,4 @@ Learning module inform steps request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleJobRequest.md b/build/docs/LearningModuleJobRequest.md index de1aea0c6..a3b4ca91c 100644 --- a/build/docs/LearningModuleJobRequest.md +++ b/build/docs/LearningModuleJobRequest.md @@ -11,4 +11,4 @@ Learning module job request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleJobResponse.md b/build/docs/LearningModuleJobResponse.md index a624ef5e2..6933a060e 100644 --- a/build/docs/LearningModuleJobResponse.md +++ b/build/docs/LearningModuleJobResponse.md @@ -13,4 +13,4 @@ Learning module job response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewGetResponse.md b/build/docs/LearningModulePreviewGetResponse.md index 603245a92..0d369d5e1 100644 --- a/build/docs/LearningModulePreviewGetResponse.md +++ b/build/docs/LearningModulePreviewGetResponse.md @@ -19,4 +19,4 @@ Learning module preview get response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewGetResponseAssignment.md b/build/docs/LearningModulePreviewGetResponseAssignment.md index e0b0cf481..57941d21d 100644 --- a/build/docs/LearningModulePreviewGetResponseAssignment.md +++ b/build/docs/LearningModulePreviewGetResponseAssignment.md @@ -17,4 +17,4 @@ Learning module preview get response assignment -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewGetResponseStep.md b/build/docs/LearningModulePreviewGetResponseStep.md index d156807e6..85e532b94 100644 --- a/build/docs/LearningModulePreviewGetResponseStep.md +++ b/build/docs/LearningModulePreviewGetResponseStep.md @@ -18,4 +18,4 @@ Learning module preview get response assignment step -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewGetScoStructure.md b/build/docs/LearningModulePreviewGetScoStructure.md index 55b48b222..d6cfa870d 100644 --- a/build/docs/LearningModulePreviewGetScoStructure.md +++ b/build/docs/LearningModulePreviewGetScoStructure.md @@ -17,4 +17,4 @@ Learning module preview get SCO structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewUpdateRequest.md b/build/docs/LearningModulePreviewUpdateRequest.md index 6462dd108..e120ba34c 100644 --- a/build/docs/LearningModulePreviewUpdateRequest.md +++ b/build/docs/LearningModulePreviewUpdateRequest.md @@ -15,4 +15,4 @@ Learning module preview update request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewUpdateRequestCurrentStep.md b/build/docs/LearningModulePreviewUpdateRequestCurrentStep.md index 7f233877f..5a9e1f436 100644 --- a/build/docs/LearningModulePreviewUpdateRequestCurrentStep.md +++ b/build/docs/LearningModulePreviewUpdateRequestCurrentStep.md @@ -13,4 +13,4 @@ Learning module preview update request current step -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewUpdateResponse.md b/build/docs/LearningModulePreviewUpdateResponse.md index a8061c141..51baf2fea 100644 --- a/build/docs/LearningModulePreviewUpdateResponse.md +++ b/build/docs/LearningModulePreviewUpdateResponse.md @@ -12,4 +12,4 @@ Learning module preview update response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewUpdateResponseAssignment.md b/build/docs/LearningModulePreviewUpdateResponseAssignment.md index 00a02f2f2..4303b4a09 100644 --- a/build/docs/LearningModulePreviewUpdateResponseAssignment.md +++ b/build/docs/LearningModulePreviewUpdateResponseAssignment.md @@ -18,4 +18,4 @@ Learning module preview update response assignment -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewUpdateResponseCurrentStep.md b/build/docs/LearningModulePreviewUpdateResponseCurrentStep.md index 8ff2c6f75..87282048f 100644 --- a/build/docs/LearningModulePreviewUpdateResponseCurrentStep.md +++ b/build/docs/LearningModulePreviewUpdateResponseCurrentStep.md @@ -11,4 +11,4 @@ Learning module preview update response current step -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewUpdateScoStructure.md b/build/docs/LearningModulePreviewUpdateScoStructure.md index 8b4e87235..775ac1e42 100644 --- a/build/docs/LearningModulePreviewUpdateScoStructure.md +++ b/build/docs/LearningModulePreviewUpdateScoStructure.md @@ -16,4 +16,4 @@ Learning module preview update SCO structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePreviewUpdateStep.md b/build/docs/LearningModulePreviewUpdateStep.md index 0e0414258..9bf397d22 100644 --- a/build/docs/LearningModulePreviewUpdateStep.md +++ b/build/docs/LearningModulePreviewUpdateStep.md @@ -16,4 +16,4 @@ Learning module preview update assignment step -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePublishRequest.md b/build/docs/LearningModulePublishRequest.md index 575dd9e53..dbb78fd03 100644 --- a/build/docs/LearningModulePublishRequest.md +++ b/build/docs/LearningModulePublishRequest.md @@ -11,4 +11,4 @@ Learning module publish request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulePublishResponse.md b/build/docs/LearningModulePublishResponse.md index 4b7f2fb00..563eae134 100644 --- a/build/docs/LearningModulePublishResponse.md +++ b/build/docs/LearningModulePublishResponse.md @@ -13,4 +13,4 @@ Learning module publish response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleReassignSummary.md b/build/docs/LearningModuleReassignSummary.md index 17aa1eb33..07edddc84 100644 --- a/build/docs/LearningModuleReassignSummary.md +++ b/build/docs/LearningModuleReassignSummary.md @@ -15,4 +15,4 @@ Learning module reassign summary data -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleRequest.md b/build/docs/LearningModuleRequest.md index 2694feac5..99ba63e0c 100644 --- a/build/docs/LearningModuleRequest.md +++ b/build/docs/LearningModuleRequest.md @@ -22,4 +22,4 @@ Learning module request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleRule.md b/build/docs/LearningModuleRule.md index 3dc7151e6..7499cc3e1 100644 --- a/build/docs/LearningModuleRule.md +++ b/build/docs/LearningModuleRule.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleRuleParts.md b/build/docs/LearningModuleRuleParts.md index 260eaa934..5d9d1ecb2 100644 --- a/build/docs/LearningModuleRuleParts.md +++ b/build/docs/LearningModuleRuleParts.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModuleSummary.md b/build/docs/LearningModuleSummary.md index b268496d1..fbe033c5d 100644 --- a/build/docs/LearningModuleSummary.md +++ b/build/docs/LearningModuleSummary.md @@ -14,4 +14,4 @@ Learning module summary data -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningModulesDomainEntityListing.md b/build/docs/LearningModulesDomainEntityListing.md index 073994af0..288e99fc9 100644 --- a/build/docs/LearningModulesDomainEntityListing.md +++ b/build/docs/LearningModulesDomainEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningScheduleSlotsQueryRequest.md b/build/docs/LearningScheduleSlotsQueryRequest.md index 7024d4643..52a0f7c6b 100644 --- a/build/docs/LearningScheduleSlotsQueryRequest.md +++ b/build/docs/LearningScheduleSlotsQueryRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningScheduleSlotsQueryResponse.md b/build/docs/LearningScheduleSlotsQueryResponse.md index 9bc5c15c2..19b235c34 100644 --- a/build/docs/LearningScheduleSlotsQueryResponse.md +++ b/build/docs/LearningScheduleSlotsQueryResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningScormResponse.md b/build/docs/LearningScormResponse.md index ab4bd9ad1..e8652f4e8 100644 --- a/build/docs/LearningScormResponse.md +++ b/build/docs/LearningScormResponse.md @@ -16,4 +16,4 @@ Learning SCORM package -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningScormUploadRequest.md b/build/docs/LearningScormUploadRequest.md index 9502d2bcb..2ea1543a8 100644 --- a/build/docs/LearningScormUploadRequest.md +++ b/build/docs/LearningScormUploadRequest.md @@ -11,4 +11,4 @@ Learning SCORM upload request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningScormUploadResponse.md b/build/docs/LearningScormUploadResponse.md index 570a4d91f..5525c0b3d 100644 --- a/build/docs/LearningScormUploadResponse.md +++ b/build/docs/LearningScormUploadResponse.md @@ -15,4 +15,4 @@ Learning SCORM upload response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningShareableContentObject.md b/build/docs/LearningShareableContentObject.md index 8af305392..aba8f4d45 100644 --- a/build/docs/LearningShareableContentObject.md +++ b/build/docs/LearningShareableContentObject.md @@ -26,4 +26,4 @@ Learning assignment SCO (Shareable Content Object) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningSlot.md b/build/docs/LearningSlot.md index b9783245c..354c239eb 100644 --- a/build/docs/LearningSlot.md +++ b/build/docs/LearningSlot.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningSlotFullDayTimeOffMarker.md b/build/docs/LearningSlotFullDayTimeOffMarker.md index c6e5fd383..95ac5142b 100644 --- a/build/docs/LearningSlotFullDayTimeOffMarker.md +++ b/build/docs/LearningSlotFullDayTimeOffMarker.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningSlotScheduleActivity.md b/build/docs/LearningSlotScheduleActivity.md index 5e43a8597..7b018ac18 100644 --- a/build/docs/LearningSlotScheduleActivity.md +++ b/build/docs/LearningSlotScheduleActivity.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LearningSlotWfmScheduleActivity.md b/build/docs/LearningSlotWfmScheduleActivity.md index 263436266..e90817e72 100644 --- a/build/docs/LearningSlotWfmScheduleActivity.md +++ b/build/docs/LearningSlotWfmScheduleActivity.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexBot.md b/build/docs/LexBot.md index 7d337d058..665f60aa3 100644 --- a/build/docs/LexBot.md +++ b/build/docs/LexBot.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexBotAlias.md b/build/docs/LexBotAlias.md index de9ba71ca..87e2daab4 100644 --- a/build/docs/LexBotAlias.md +++ b/build/docs/LexBotAlias.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexBotAliasEntityListing.md b/build/docs/LexBotAliasEntityListing.md index e1c514d76..d56b94f01 100644 --- a/build/docs/LexBotAliasEntityListing.md +++ b/build/docs/LexBotAliasEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexBotEntityListing.md b/build/docs/LexBotEntityListing.md index 6d9c23b27..2ec03c13a 100644 --- a/build/docs/LexBotEntityListing.md +++ b/build/docs/LexBotEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexIntent.md b/build/docs/LexIntent.md index 0d3d7ffa4..0c521704c 100644 --- a/build/docs/LexIntent.md +++ b/build/docs/LexIntent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexSlot.md b/build/docs/LexSlot.md index c97445773..9c7e45cbb 100644 --- a/build/docs/LexSlot.md +++ b/build/docs/LexSlot.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexV2Bot.md b/build/docs/LexV2Bot.md index 3be380a95..fda4ed412 100644 --- a/build/docs/LexV2Bot.md +++ b/build/docs/LexV2Bot.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexV2BotAlias.md b/build/docs/LexV2BotAlias.md index 78d2af0b8..55dffc0e1 100644 --- a/build/docs/LexV2BotAlias.md +++ b/build/docs/LexV2BotAlias.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexV2BotAliasEntityListing.md b/build/docs/LexV2BotAliasEntityListing.md index c15e9187a..07010e957 100644 --- a/build/docs/LexV2BotAliasEntityListing.md +++ b/build/docs/LexV2BotAliasEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexV2BotEntityListing.md b/build/docs/LexV2BotEntityListing.md index 6322a16b1..680dfc420 100644 --- a/build/docs/LexV2BotEntityListing.md +++ b/build/docs/LexV2BotEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexV2Intent.md b/build/docs/LexV2Intent.md index 5b4814bda..72eb12b4e 100644 --- a/build/docs/LexV2Intent.md +++ b/build/docs/LexV2Intent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LexV2Slot.md b/build/docs/LexV2Slot.md index 9f9586a61..54ac84fb7 100644 --- a/build/docs/LexV2Slot.md +++ b/build/docs/LexV2Slot.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Library.md b/build/docs/Library.md index 557aed7df..f6b3e4dee 100644 --- a/build/docs/Library.md +++ b/build/docs/Library.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LibraryBatchRequest.md b/build/docs/LibraryBatchRequest.md index fed4e8d04..533342045 100644 --- a/build/docs/LibraryBatchRequest.md +++ b/build/docs/LibraryBatchRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LibraryEntityListing.md b/build/docs/LibraryEntityListing.md index fa8518a32..6169f66a8 100644 --- a/build/docs/LibraryEntityListing.md +++ b/build/docs/LibraryEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LicenseAPI.md b/build/docs/LicenseAPI.md index 5850962db..6182e8172 100644 --- a/build/docs/LicenseAPI.md +++ b/build/docs/LicenseAPI.md @@ -466,4 +466,4 @@ LicenseAPI.postLicenseUsers(body: body) { (response, error) in [**[String:JSON]**](JSON) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LicenseAssignmentRequest.md b/build/docs/LicenseAssignmentRequest.md index 0ca3023a3..9393059cb 100644 --- a/build/docs/LicenseAssignmentRequest.md +++ b/build/docs/LicenseAssignmentRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LicenseBatchAssignmentRequest.md b/build/docs/LicenseBatchAssignmentRequest.md index 96c84de09..49798c66c 100644 --- a/build/docs/LicenseBatchAssignmentRequest.md +++ b/build/docs/LicenseBatchAssignmentRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LicenseDefinition.md b/build/docs/LicenseDefinition.md index b7888b187..cd325c34a 100644 --- a/build/docs/LicenseDefinition.md +++ b/build/docs/LicenseDefinition.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LicenseOrgToggle.md b/build/docs/LicenseOrgToggle.md index 927b9e2f4..394155d17 100644 --- a/build/docs/LicenseOrgToggle.md +++ b/build/docs/LicenseOrgToggle.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LicenseUpdateStatus.md b/build/docs/LicenseUpdateStatus.md index 0066fd48e..fca0b5bbf 100644 --- a/build/docs/LicenseUpdateStatus.md +++ b/build/docs/LicenseUpdateStatus.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LicenseUser.md b/build/docs/LicenseUser.md index a8175b814..ad90cb7d6 100644 --- a/build/docs/LicenseUser.md +++ b/build/docs/LicenseUser.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Limit.md b/build/docs/Limit.md index d932634ea..82de7e6bf 100644 --- a/build/docs/Limit.md +++ b/build/docs/Limit.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LimitChangeRequestDetails.md b/build/docs/LimitChangeRequestDetails.md index d878e163a..73bd63b62 100644 --- a/build/docs/LimitChangeRequestDetails.md +++ b/build/docs/LimitChangeRequestDetails.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LimitChangeRequestsEntityListing.md b/build/docs/LimitChangeRequestsEntityListing.md index e0c564422..d6fcc6d47 100644 --- a/build/docs/LimitChangeRequestsEntityListing.md +++ b/build/docs/LimitChangeRequestsEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LimitCount.md b/build/docs/LimitCount.md index 0b15b71c8..08fd357cf 100644 --- a/build/docs/LimitCount.md +++ b/build/docs/LimitCount.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LimitCountListing.md b/build/docs/LimitCountListing.md index 38f4b5e0f..bfafc5ec0 100644 --- a/build/docs/LimitCountListing.md +++ b/build/docs/LimitCountListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LimitDocs.md b/build/docs/LimitDocs.md index 15db94a48..a94f46115 100644 --- a/build/docs/LimitDocs.md +++ b/build/docs/LimitDocs.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LimitDocumentation.md b/build/docs/LimitDocumentation.md index b24eacde1..d16bd9591 100644 --- a/build/docs/LimitDocumentation.md +++ b/build/docs/LimitDocumentation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LimitsEntityListing.md b/build/docs/LimitsEntityListing.md index 700e9fce8..0b1808b88 100644 --- a/build/docs/LimitsEntityListing.md +++ b/build/docs/LimitsEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Line.md b/build/docs/Line.md index 91295c98e..1d18e4eb4 100644 --- a/build/docs/Line.md +++ b/build/docs/Line.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LineBase.md b/build/docs/LineBase.md index a4f72e8fa..099575fbd 100644 --- a/build/docs/LineBase.md +++ b/build/docs/LineBase.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LineBaseEntityListing.md b/build/docs/LineBaseEntityListing.md index 5a77c478f..250da215d 100644 --- a/build/docs/LineBaseEntityListing.md +++ b/build/docs/LineBaseEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LineEntityListing.md b/build/docs/LineEntityListing.md index b29dd9ee6..427dc9775 100644 --- a/build/docs/LineEntityListing.md +++ b/build/docs/LineEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LineId.md b/build/docs/LineId.md index 453c06ff3..cd071dee0 100644 --- a/build/docs/LineId.md +++ b/build/docs/LineId.md @@ -12,4 +12,4 @@ User information for a Line account -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LineStatus.md b/build/docs/LineStatus.md index 1463ef3ef..57eb94204 100644 --- a/build/docs/LineStatus.md +++ b/build/docs/LineStatus.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LineUserId.md b/build/docs/LineUserId.md index 12b963616..0f7915038 100644 --- a/build/docs/LineUserId.md +++ b/build/docs/LineUserId.md @@ -11,4 +11,4 @@ Channel-specific User ID for Line accounts -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LinkConfiguration.md b/build/docs/LinkConfiguration.md index a2c1f527a..5a6cbb1f0 100644 --- a/build/docs/LinkConfiguration.md +++ b/build/docs/LinkConfiguration.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListAlternativeShiftTradesResponse.md b/build/docs/ListAlternativeShiftTradesResponse.md index 4ec43f79b..62fa0f906 100644 --- a/build/docs/ListAlternativeShiftTradesResponse.md +++ b/build/docs/ListAlternativeShiftTradesResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListItemComponent.md b/build/docs/ListItemComponent.md index a4b7483ec..85c482104 100644 --- a/build/docs/ListItemComponent.md +++ b/build/docs/ListItemComponent.md @@ -17,4 +17,4 @@ An entry in a List template. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperAgentWorkPlanField.md b/build/docs/ListWrapperAgentWorkPlanField.md index 45c8920a5..9561f7370 100644 --- a/build/docs/ListWrapperAgentWorkPlanField.md +++ b/build/docs/ListWrapperAgentWorkPlanField.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperAlternativeShiftBuSettingsActivityCategory.md b/build/docs/ListWrapperAlternativeShiftBuSettingsActivityCategory.md index 1b90f8635..cdf96d504 100644 --- a/build/docs/ListWrapperAlternativeShiftBuSettingsActivityCategory.md +++ b/build/docs/ListWrapperAlternativeShiftBuSettingsActivityCategory.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperAlternativeShiftBuSettingsGranularity.md b/build/docs/ListWrapperAlternativeShiftBuSettingsGranularity.md index 9214602a0..531a14c94 100644 --- a/build/docs/ListWrapperAlternativeShiftBuSettingsGranularity.md +++ b/build/docs/ListWrapperAlternativeShiftBuSettingsGranularity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperBidGroupWorkPlanRequest.md b/build/docs/ListWrapperBidGroupWorkPlanRequest.md index 98211b3e1..66a3a59ff 100644 --- a/build/docs/ListWrapperBidGroupWorkPlanRequest.md +++ b/build/docs/ListWrapperBidGroupWorkPlanRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperFixedAvailability.md b/build/docs/ListWrapperFixedAvailability.md index 59f16212b..ce995d970 100644 --- a/build/docs/ListWrapperFixedAvailability.md +++ b/build/docs/ListWrapperFixedAvailability.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperInterval.md b/build/docs/ListWrapperInterval.md index 1375da32e..9b6664e56 100644 --- a/build/docs/ListWrapperInterval.md +++ b/build/docs/ListWrapperInterval.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperSecondaryPresence.md b/build/docs/ListWrapperSecondaryPresence.md index 4bc3e54da..3446f70c3 100644 --- a/build/docs/ListWrapperSecondaryPresence.md +++ b/build/docs/ListWrapperSecondaryPresence.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperShiftStartVariance.md b/build/docs/ListWrapperShiftStartVariance.md index c3e52252f..a782704a5 100644 --- a/build/docs/ListWrapperShiftStartVariance.md +++ b/build/docs/ListWrapperShiftStartVariance.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListWrapperString.md b/build/docs/ListWrapperString.md index 17d59da57..c93fc2da9 100644 --- a/build/docs/ListWrapperString.md +++ b/build/docs/ListWrapperString.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListedDictionaryFeedback.md b/build/docs/ListedDictionaryFeedback.md index e8cc11aeb..12b821e4e 100644 --- a/build/docs/ListedDictionaryFeedback.md +++ b/build/docs/ListedDictionaryFeedback.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListedProgram.md b/build/docs/ListedProgram.md index 83bb35006..6a95b1aa9 100644 --- a/build/docs/ListedProgram.md +++ b/build/docs/ListedProgram.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ListedTopic.md b/build/docs/ListedTopic.md index 8bf1ef3c6..76787c02a 100644 --- a/build/docs/ListedTopic.md +++ b/build/docs/ListedTopic.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Listing.md b/build/docs/Listing.md index 1fc0ee4f9..69c9ccd13 100644 --- a/build/docs/Listing.md +++ b/build/docs/Listing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocalDateRange.md b/build/docs/LocalDateRange.md index 07c2f11c5..f13c95925 100644 --- a/build/docs/LocalDateRange.md +++ b/build/docs/LocalDateRange.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocalEncryptionConfiguration.md b/build/docs/LocalEncryptionConfiguration.md index 985ecbac6..935ad0698 100644 --- a/build/docs/LocalEncryptionConfiguration.md +++ b/build/docs/LocalEncryptionConfiguration.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocalEncryptionKeyRequest.md b/build/docs/LocalEncryptionKeyRequest.md index 03a176327..dac4e5e89 100644 --- a/build/docs/LocalEncryptionKeyRequest.md +++ b/build/docs/LocalEncryptionKeyRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocaleFlowVersionInfo.md b/build/docs/LocaleFlowVersionInfo.md index 7f78b0123..349527159 100644 --- a/build/docs/LocaleFlowVersionInfo.md +++ b/build/docs/LocaleFlowVersionInfo.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocaleHealth.md b/build/docs/LocaleHealth.md index ae7b4b384..cc958803d 100644 --- a/build/docs/LocaleHealth.md +++ b/build/docs/LocaleHealth.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocaleInfo.md b/build/docs/LocaleInfo.md index fdb494f8e..03d3059d5 100644 --- a/build/docs/LocaleInfo.md +++ b/build/docs/LocaleInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocalizedLabels.md b/build/docs/LocalizedLabels.md index 46af3ed9a..b06089ebe 100644 --- a/build/docs/LocalizedLabels.md +++ b/build/docs/LocalizedLabels.md @@ -12,4 +12,4 @@ Contains localized labels used in messenger apps -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Location.md b/build/docs/Location.md index c6178f2a8..0327864a8 100644 --- a/build/docs/Location.md +++ b/build/docs/Location.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationAddress.md b/build/docs/LocationAddress.md index fdccd6d2b..9183959d5 100644 --- a/build/docs/LocationAddress.md +++ b/build/docs/LocationAddress.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationAddressVerificationDetails.md b/build/docs/LocationAddressVerificationDetails.md index 9810ecb97..b317121c0 100644 --- a/build/docs/LocationAddressVerificationDetails.md +++ b/build/docs/LocationAddressVerificationDetails.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationCreateDefinition.md b/build/docs/LocationCreateDefinition.md index cc7b6fc25..5f5b278c1 100644 --- a/build/docs/LocationCreateDefinition.md +++ b/build/docs/LocationCreateDefinition.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationDefinition.md b/build/docs/LocationDefinition.md index 4c7ad38e6..9b137af10 100644 --- a/build/docs/LocationDefinition.md +++ b/build/docs/LocationDefinition.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationEmergencyNumber.md b/build/docs/LocationEmergencyNumber.md index d3054b480..e27d8eec7 100644 --- a/build/docs/LocationEmergencyNumber.md +++ b/build/docs/LocationEmergencyNumber.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationEntityListing.md b/build/docs/LocationEntityListing.md index 8a4d157fc..b770e6b40 100644 --- a/build/docs/LocationEntityListing.md +++ b/build/docs/LocationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationImage.md b/build/docs/LocationImage.md index 344aa2e6a..a628586e8 100644 --- a/build/docs/LocationImage.md +++ b/build/docs/LocationImage.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationSearchCriteria.md b/build/docs/LocationSearchCriteria.md index 93631ea49..9749805ba 100644 --- a/build/docs/LocationSearchCriteria.md +++ b/build/docs/LocationSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationSearchRequest.md b/build/docs/LocationSearchRequest.md index 80e47c03a..4b7b6e368 100644 --- a/build/docs/LocationSearchRequest.md +++ b/build/docs/LocationSearchRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationUpdateDefinition.md b/build/docs/LocationUpdateDefinition.md index b86f69322..6d452dc91 100644 --- a/build/docs/LocationUpdateDefinition.md +++ b/build/docs/LocationUpdateDefinition.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationsAPI.md b/build/docs/LocationsAPI.md index f4956407e..367731a53 100644 --- a/build/docs/LocationsAPI.md +++ b/build/docs/LocationsAPI.md @@ -421,4 +421,4 @@ LocationsAPI.postLocationsSearch(body: body) { (response, error) in [**LocationsSearchResponse**](LocationsSearchResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LocationsSearchResponse.md b/build/docs/LocationsSearchResponse.md index ffccf9d5e..646f7b549 100644 --- a/build/docs/LocationsSearchResponse.md +++ b/build/docs/LocationsSearchResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LockInfo.md b/build/docs/LockInfo.md index 6dfd16e2e..8c02f66c7 100644 --- a/build/docs/LockInfo.md +++ b/build/docs/LockInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LogCaptureAPI.md b/build/docs/LogCaptureAPI.md index a4bcafa28..8fd6119e7 100644 --- a/build/docs/LogCaptureAPI.md +++ b/build/docs/LogCaptureAPI.md @@ -371,4 +371,4 @@ LogCaptureAPI.postDiagnosticsLogcaptureBrowserUser(userId: userId, body: body) { [**LogCaptureUserConfiguration**](LogCaptureUserConfiguration) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LogCaptureDownloadExecutionResponse.md b/build/docs/LogCaptureDownloadExecutionResponse.md index 5716f8711..573ed7086 100644 --- a/build/docs/LogCaptureDownloadExecutionResponse.md +++ b/build/docs/LogCaptureDownloadExecutionResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LogCaptureQueryRequest.md b/build/docs/LogCaptureQueryRequest.md index 2d3712e69..39f7e49b5 100644 --- a/build/docs/LogCaptureQueryRequest.md +++ b/build/docs/LogCaptureQueryRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LogCaptureQueryResponse.md b/build/docs/LogCaptureQueryResponse.md index 93682b7c4..9592b19ba 100644 --- a/build/docs/LogCaptureQueryResponse.md +++ b/build/docs/LogCaptureQueryResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LogCaptureUserConfiguration.md b/build/docs/LogCaptureUserConfiguration.md index 835d50878..e8d39523c 100644 --- a/build/docs/LogCaptureUserConfiguration.md +++ b/build/docs/LogCaptureUserConfiguration.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LogEntry.md b/build/docs/LogEntry.md index 871a9aca5..1c9a2aa02 100644 --- a/build/docs/LogEntry.md +++ b/build/docs/LogEntry.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LogicalInterfaceEntityListing.md b/build/docs/LogicalInterfaceEntityListing.md index a096e8961..8711a3a17 100644 --- a/build/docs/LogicalInterfaceEntityListing.md +++ b/build/docs/LogicalInterfaceEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LongTermForecastPlanningGroupData.md b/build/docs/LongTermForecastPlanningGroupData.md index 348385e23..3da2ea421 100644 --- a/build/docs/LongTermForecastPlanningGroupData.md +++ b/build/docs/LongTermForecastPlanningGroupData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LongTermForecastResult.md b/build/docs/LongTermForecastResult.md index ee11e348d..5871b7000 100644 --- a/build/docs/LongTermForecastResult.md +++ b/build/docs/LongTermForecastResult.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/LongTermForecastResultResponse.md b/build/docs/LongTermForecastResultResponse.md index ac25d2db2..d2eec6faf 100644 --- a/build/docs/LongTermForecastResultResponse.md +++ b/build/docs/LongTermForecastResultResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MailFromResult.md b/build/docs/MailFromResult.md index 8b7a8c8c7..810de6c40 100644 --- a/build/docs/MailFromResult.md +++ b/build/docs/MailFromResult.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ManagementUnit.md b/build/docs/ManagementUnit.md index aab6f833d..139a9a773 100644 --- a/build/docs/ManagementUnit.md +++ b/build/docs/ManagementUnit.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ManagementUnitListing.md b/build/docs/ManagementUnitListing.md index c13cf7ccc..b133b4816 100644 --- a/build/docs/ManagementUnitListing.md +++ b/build/docs/ManagementUnitListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | Deprecated, paging is not supported | [optional] | | **pageNumber** | **Int** | Deprecated, paging is not supported | [optional] | | **total** | **Int64** | Deprecated, paging is not supported | [optional] | -| **nextUri** | **String** | Deprecated, paging is not supported | [optional] | -| **previousUri** | **String** | Deprecated, paging is not supported | [optional] | -| **lastUri** | **String** | Deprecated, paging is not supported | [optional] | | **firstUri** | **String** | Deprecated, paging is not supported | [optional] | +| **lastUri** | **String** | Deprecated, paging is not supported | [optional] | | **pageCount** | **Int** | Deprecated, paging is not supported | [optional] | +| **nextUri** | **String** | Deprecated, paging is not supported | [optional] | +| **previousUri** | **String** | Deprecated, paging is not supported | [optional] | | **selfUri** | **String** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ManagementUnitReference.md b/build/docs/ManagementUnitReference.md index 9b1dcbe0a..c8a42b523 100644 --- a/build/docs/ManagementUnitReference.md +++ b/build/docs/ManagementUnitReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ManagementUnitSettingsRequest.md b/build/docs/ManagementUnitSettingsRequest.md index 345bf6817..d933ce3fd 100644 --- a/build/docs/ManagementUnitSettingsRequest.md +++ b/build/docs/ManagementUnitSettingsRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ManagementUnitSettingsResponse.md b/build/docs/ManagementUnitSettingsResponse.md index 48b05a969..80d38a87c 100644 --- a/build/docs/ManagementUnitSettingsResponse.md +++ b/build/docs/ManagementUnitSettingsResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Manager.md b/build/docs/Manager.md index 5203bfe7c..c89fe4585 100644 --- a/build/docs/Manager.md +++ b/build/docs/Manager.md @@ -12,4 +12,4 @@ Defines a SCIM manager. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MarkContactAddressUncontactableActionSettings.md b/build/docs/MarkContactAddressUncontactableActionSettings.md index 2ea625d24..58d781b15 100644 --- a/build/docs/MarkContactAddressUncontactableActionSettings.md +++ b/build/docs/MarkContactAddressUncontactableActionSettings.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MarkContactUncontactableActionSettings.md b/build/docs/MarkContactUncontactableActionSettings.md index b6e5f618f..8147be9f2 100644 --- a/build/docs/MarkContactUncontactableActionSettings.md +++ b/build/docs/MarkContactUncontactableActionSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Markdown.md b/build/docs/Markdown.md index 391c9dee5..d6a0f2565 100644 --- a/build/docs/Markdown.md +++ b/build/docs/Markdown.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MaskingRule.md b/build/docs/MaskingRule.md new file mode 100644 index 000000000..961a63642 --- /dev/null +++ b/build/docs/MaskingRule.md @@ -0,0 +1,22 @@ +# MaskingRule + +## MaskingRule + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **_id** | **String** | The globally unique identifier for the object. | [optional] | +| **name** | **String** | Masking rule name. | | +| **_description** | **String** | Description about masking rule. | [optional] | +| **substituteCharacter** | **String** | Replacement character for masked text character. | | +| **definition** | **String** | Definition of masking rule (a valid regex or builtin AI based mask name). | | +| **enabled** | **Bool** | True/False | | +| **type** | **String** | Masking rule type | | +| **integrations** | **[String]** | Associated integration channels | [optional] | +| **dateCreated** | [**Date**](Date) | Date when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] | +| **dateModified** | [**Date**](Date) | Date when the rule was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MaskingRuleListing.md b/build/docs/MaskingRuleListing.md new file mode 100644 index 000000000..e68e92d77 --- /dev/null +++ b/build/docs/MaskingRuleListing.md @@ -0,0 +1,13 @@ +# MaskingRuleListing + +## MaskingRuleListing + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **entities** | [**[MaskingRule]**](MaskingRule) | | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MaskingRuleValidateRequest.md b/build/docs/MaskingRuleValidateRequest.md new file mode 100644 index 000000000..c559f98ce --- /dev/null +++ b/build/docs/MaskingRuleValidateRequest.md @@ -0,0 +1,14 @@ +# MaskingRuleValidateRequest + +## MaskingRuleValidateRequest + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **text** | **String** | Text to mask. | | +| **definition** | **String** | Regex to be applied | | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MaskingRuleValidateResponse.md b/build/docs/MaskingRuleValidateResponse.md new file mode 100644 index 000000000..054040049 --- /dev/null +++ b/build/docs/MaskingRuleValidateResponse.md @@ -0,0 +1,15 @@ +# MaskingRuleValidateResponse + +## MaskingRuleValidateResponse + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **valid** | **Bool** | is masking rule definition valid? | [optional] | +| **validationMessage** | **String** | Validation message. | [optional] | +| **maskedText** | **String** | Masked text. | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MatchCriteria.md b/build/docs/MatchCriteria.md index 7f33d35e8..4979b8d44 100644 --- a/build/docs/MatchCriteria.md +++ b/build/docs/MatchCriteria.md @@ -14,4 +14,4 @@ Defines a simple matching condition -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MatchCriteriaTestResult.md b/build/docs/MatchCriteriaTestResult.md index 2c806deaf..c2ba9a79e 100644 --- a/build/docs/MatchCriteriaTestResult.md +++ b/build/docs/MatchCriteriaTestResult.md @@ -17,4 +17,4 @@ Results of a matching expression -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MatchShiftTradeRequest.md b/build/docs/MatchShiftTradeRequest.md index ace585348..3c5c69452 100644 --- a/build/docs/MatchShiftTradeRequest.md +++ b/build/docs/MatchShiftTradeRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MatchShiftTradeResponse.md b/build/docs/MatchShiftTradeResponse.md index e4ccf51fd..f14558292 100644 --- a/build/docs/MatchShiftTradeResponse.md +++ b/build/docs/MatchShiftTradeResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MatchTestResult.md b/build/docs/MatchTestResult.md index b1eb75e28..7b7f59576 100644 --- a/build/docs/MatchTestResult.md +++ b/build/docs/MatchTestResult.md @@ -12,4 +12,4 @@ Information about the results being matched by the expressions -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MaxLength.md b/build/docs/MaxLength.md index 6fccb6077..245c7210c 100644 --- a/build/docs/MaxLength.md +++ b/build/docs/MaxLength.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MaxParticipants.md b/build/docs/MaxParticipants.md index 655535e9c..da2c7d931 100644 --- a/build/docs/MaxParticipants.md +++ b/build/docs/MaxParticipants.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaParticipantRequest.md b/build/docs/MediaParticipantRequest.md index 45ad3b4c1..7159a4014 100644 --- a/build/docs/MediaParticipantRequest.md +++ b/build/docs/MediaParticipantRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaPolicies.md b/build/docs/MediaPolicies.md index 891e68d39..2b7fc85f0 100644 --- a/build/docs/MediaPolicies.md +++ b/build/docs/MediaPolicies.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaRegions.md b/build/docs/MediaRegions.md index 3c5676789..2db7ed1b2 100644 --- a/build/docs/MediaRegions.md +++ b/build/docs/MediaRegions.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaResult.md b/build/docs/MediaResult.md index 491adcf00..e23fba8b6 100644 --- a/build/docs/MediaResult.md +++ b/build/docs/MediaResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaSettings.md b/build/docs/MediaSettings.md index d6af48743..af579e4c7 100644 --- a/build/docs/MediaSettings.md +++ b/build/docs/MediaSettings.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaSummary.md b/build/docs/MediaSummary.md index 49940f650..6d5232f6a 100644 --- a/build/docs/MediaSummary.md +++ b/build/docs/MediaSummary.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaSummaryDetail.md b/build/docs/MediaSummaryDetail.md index ceb64414f..d4950939b 100644 --- a/build/docs/MediaSummaryDetail.md +++ b/build/docs/MediaSummaryDetail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaTranscription.md b/build/docs/MediaTranscription.md index 21dca0061..1a2f4e181 100644 --- a/build/docs/MediaTranscription.md +++ b/build/docs/MediaTranscription.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaType.md b/build/docs/MediaType.md index 26be59722..6c4abce65 100644 --- a/build/docs/MediaType.md +++ b/build/docs/MediaType.md @@ -11,4 +11,4 @@ Media type definition -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaTypeAccess.md b/build/docs/MediaTypeAccess.md index b9745d7ed..8a83dd8b8 100644 --- a/build/docs/MediaTypeAccess.md +++ b/build/docs/MediaTypeAccess.md @@ -12,4 +12,4 @@ Media type access definitions -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaTypes.md b/build/docs/MediaTypes.md index 6cde03509..c332a7bbe 100644 --- a/build/docs/MediaTypes.md +++ b/build/docs/MediaTypes.md @@ -11,4 +11,4 @@ Media types -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MediaUtilization.md b/build/docs/MediaUtilization.md index cdbfac71c..d05e69cf8 100644 --- a/build/docs/MediaUtilization.md +++ b/build/docs/MediaUtilization.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Member.md b/build/docs/Member.md index 85531e7fc..cc322b02e 100644 --- a/build/docs/Member.md +++ b/build/docs/Member.md @@ -12,4 +12,4 @@ The associated user reference as a member of a performance profile -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MemberEntity.md b/build/docs/MemberEntity.md index 1453c0623..fb63d5d27 100644 --- a/build/docs/MemberEntity.md +++ b/build/docs/MemberEntity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MemberGroup.md b/build/docs/MemberGroup.md index 76aae7bde..3d5de2088 100644 --- a/build/docs/MemberGroup.md +++ b/build/docs/MemberGroup.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MemberListing.md b/build/docs/MemberListing.md index 59fd13044..4dfc93e52 100644 --- a/build/docs/MemberListing.md +++ b/build/docs/MemberListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MergeOperation.md b/build/docs/MergeOperation.md index 6e2a90b30..d047a84e3 100644 --- a/build/docs/MergeOperation.md +++ b/build/docs/MergeOperation.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MergeRequest.md b/build/docs/MergeRequest.md index 9b53438d0..25b9a2fd2 100644 --- a/build/docs/MergeRequest.md +++ b/build/docs/MergeRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Message.md b/build/docs/Message.md index 0a372fbad..3ff96d218 100644 --- a/build/docs/Message.md +++ b/build/docs/Message.md @@ -39,4 +39,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageContent.md b/build/docs/MessageContent.md index 9f1881593..91342b940 100644 --- a/build/docs/MessageContent.md +++ b/build/docs/MessageContent.md @@ -26,4 +26,4 @@ Message content element. If contentType = \"Attachment\" only one -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageConversation.md b/build/docs/MessageConversation.md index 177b7cac8..9c9fba705 100644 --- a/build/docs/MessageConversation.md +++ b/build/docs/MessageConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageConversationEntityListing.md b/build/docs/MessageConversationEntityListing.md index 804c11cff..0b35d409e 100644 --- a/build/docs/MessageConversationEntityListing.md +++ b/build/docs/MessageConversationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageData.md b/build/docs/MessageData.md index 8153ff360..cf00dde46 100644 --- a/build/docs/MessageData.md +++ b/build/docs/MessageData.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageDetails.md b/build/docs/MessageDetails.md index 8c5945136..585f5eb6a 100644 --- a/build/docs/MessageDetails.md +++ b/build/docs/MessageDetails.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageEvaluation.md b/build/docs/MessageEvaluation.md index bd681f967..96e0249ba 100644 --- a/build/docs/MessageEvaluation.md +++ b/build/docs/MessageEvaluation.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageFooter.md b/build/docs/MessageFooter.md index cb835f941..9c65f4434 100644 --- a/build/docs/MessageFooter.md +++ b/build/docs/MessageFooter.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageHeader.md b/build/docs/MessageHeader.md index fc9d52e31..f50ed7d25 100644 --- a/build/docs/MessageHeader.md +++ b/build/docs/MessageHeader.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageInfo.md b/build/docs/MessageInfo.md index c435acf2a..b1d426597 100644 --- a/build/docs/MessageInfo.md +++ b/build/docs/MessageInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageMedia.md b/build/docs/MessageMedia.md index 0a9c85482..6b096ffe3 100644 --- a/build/docs/MessageMedia.md +++ b/build/docs/MessageMedia.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageMediaAttachment.md b/build/docs/MessageMediaAttachment.md index 4a0fffb15..17d689986 100644 --- a/build/docs/MessageMediaAttachment.md +++ b/build/docs/MessageMediaAttachment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageMediaData.md b/build/docs/MessageMediaData.md index 9c1beca78..37a0a57d9 100644 --- a/build/docs/MessageMediaData.md +++ b/build/docs/MessageMediaData.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageMediaParticipant.md b/build/docs/MessageMediaParticipant.md index fef9748f5..d219075af 100644 --- a/build/docs/MessageMediaParticipant.md +++ b/build/docs/MessageMediaParticipant.md @@ -53,4 +53,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageMediaPolicy.md b/build/docs/MessageMediaPolicy.md index 66e4c46ee..b731cee9c 100644 --- a/build/docs/MessageMediaPolicy.md +++ b/build/docs/MessageMediaPolicy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageMediaPolicyConditions.md b/build/docs/MessageMediaPolicyConditions.md index de8bc6efd..76c41aaaf 100644 --- a/build/docs/MessageMediaPolicyConditions.md +++ b/build/docs/MessageMediaPolicyConditions.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageSticker.md b/build/docs/MessageSticker.md index 49bdebed1..5dfd057ff 100644 --- a/build/docs/MessageSticker.md +++ b/build/docs/MessageSticker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageStickerAttachment.md b/build/docs/MessageStickerAttachment.md index fda70c4b1..b0b0b8ff9 100644 --- a/build/docs/MessageStickerAttachment.md +++ b/build/docs/MessageStickerAttachment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessageTypingEventRequest.md b/build/docs/MessageTypingEventRequest.md index e51fdffea..df32657a6 100644 --- a/build/docs/MessageTypingEventRequest.md +++ b/build/docs/MessageTypingEventRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingAPI.md b/build/docs/MessagingAPI.md index ccd7a630f..a59bb24a1 100644 --- a/build/docs/MessagingAPI.md +++ b/build/docs/MessagingAPI.md @@ -683,4 +683,4 @@ MessagingAPI.putMessagingSettingsDefault(body: body) { (response, error) in [**MessagingSetting**](MessagingSetting) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCampaign.md b/build/docs/MessagingCampaign.md index fbe53ec9c..08cc1c46f 100644 --- a/build/docs/MessagingCampaign.md +++ b/build/docs/MessagingCampaign.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCampaignDiagnostics.md b/build/docs/MessagingCampaignDiagnostics.md index 44745a09a..0fb6320fd 100644 --- a/build/docs/MessagingCampaignDiagnostics.md +++ b/build/docs/MessagingCampaignDiagnostics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCampaignDivisionView.md b/build/docs/MessagingCampaignDivisionView.md index 09b587468..de4709206 100644 --- a/build/docs/MessagingCampaignDivisionView.md +++ b/build/docs/MessagingCampaignDivisionView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCampaignDivisionViewEntityListing.md b/build/docs/MessagingCampaignDivisionViewEntityListing.md index fb00efdde..41d487834 100644 --- a/build/docs/MessagingCampaignDivisionViewEntityListing.md +++ b/build/docs/MessagingCampaignDivisionViewEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCampaignEntityListing.md b/build/docs/MessagingCampaignEntityListing.md index 5cbab996a..da21e868a 100644 --- a/build/docs/MessagingCampaignEntityListing.md +++ b/build/docs/MessagingCampaignEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCampaignSchedule.md b/build/docs/MessagingCampaignSchedule.md index 81d531915..3aeacedb6 100644 --- a/build/docs/MessagingCampaignSchedule.md +++ b/build/docs/MessagingCampaignSchedule.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCampaignScheduleEntityListing.md b/build/docs/MessagingCampaignScheduleEntityListing.md index 2a39b7d10..3afb33a04 100644 --- a/build/docs/MessagingCampaignScheduleEntityListing.md +++ b/build/docs/MessagingCampaignScheduleEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCommunicationAnsweredEvent.md b/build/docs/MessagingCommunicationAnsweredEvent.md index 955aa98e6..a376f386d 100644 --- a/build/docs/MessagingCommunicationAnsweredEvent.md +++ b/build/docs/MessagingCommunicationAnsweredEvent.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCommunicationDispositionAppliedEvent.md b/build/docs/MessagingCommunicationDispositionAppliedEvent.md index c732be8a0..d20ece444 100644 --- a/build/docs/MessagingCommunicationDispositionAppliedEvent.md +++ b/build/docs/MessagingCommunicationDispositionAppliedEvent.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingCommunicationEndedEvent.md b/build/docs/MessagingCommunicationEndedEvent.md index 2c2a67137..caa8a9d57 100644 --- a/build/docs/MessagingCommunicationEndedEvent.md +++ b/build/docs/MessagingCommunicationEndedEvent.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingConfigListing.md b/build/docs/MessagingConfigListing.md index 2c9332ac8..c63fcc58a 100644 --- a/build/docs/MessagingConfigListing.md +++ b/build/docs/MessagingConfigListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingEndTransferEvent.md b/build/docs/MessagingEndTransferEvent.md index 192da264e..2282467e9 100644 --- a/build/docs/MessagingEndTransferEvent.md +++ b/build/docs/MessagingEndTransferEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingExternalEstablishedEvent.md b/build/docs/MessagingExternalEstablishedEvent.md index 5ea8d55c8..c8bdfdd1b 100644 --- a/build/docs/MessagingExternalEstablishedEvent.md +++ b/build/docs/MessagingExternalEstablishedEvent.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingFlowEstablishedEvent.md b/build/docs/MessagingFlowEstablishedEvent.md index 6f625c85a..dd2aa5468 100644 --- a/build/docs/MessagingFlowEstablishedEvent.md +++ b/build/docs/MessagingFlowEstablishedEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingHoldUpdatedEvent.md b/build/docs/MessagingHoldUpdatedEvent.md index 6daddc6d9..d880fb073 100644 --- a/build/docs/MessagingHoldUpdatedEvent.md +++ b/build/docs/MessagingHoldUpdatedEvent.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingInitialConfiguration.md b/build/docs/MessagingInitialConfiguration.md index 0353cb049..1f44314d8 100644 --- a/build/docs/MessagingInitialConfiguration.md +++ b/build/docs/MessagingInitialConfiguration.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingIntegration.md b/build/docs/MessagingIntegration.md index 70668c029..f6bb84051 100644 --- a/build/docs/MessagingIntegration.md +++ b/build/docs/MessagingIntegration.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingIntegrationEntityListing.md b/build/docs/MessagingIntegrationEntityListing.md index a3b54285b..c2842758b 100644 --- a/build/docs/MessagingIntegrationEntityListing.md +++ b/build/docs/MessagingIntegrationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingProgressTransferEvent.md b/build/docs/MessagingProgressTransferEvent.md index e87bd86b0..35d5b6399 100644 --- a/build/docs/MessagingProgressTransferEvent.md +++ b/build/docs/MessagingProgressTransferEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingRecipient.md b/build/docs/MessagingRecipient.md index bd58aac42..f21033072 100644 --- a/build/docs/MessagingRecipient.md +++ b/build/docs/MessagingRecipient.md @@ -19,4 +19,4 @@ Information about the recipient the message is sent to or received from. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingRoutingEstablishedEvent.md b/build/docs/MessagingRoutingEstablishedEvent.md index 5ade634ca..0f80c6c20 100644 --- a/build/docs/MessagingRoutingEstablishedEvent.md +++ b/build/docs/MessagingRoutingEstablishedEvent.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingRoutingTransferEvent.md b/build/docs/MessagingRoutingTransferEvent.md index c7d6920d5..8551f8726 100644 --- a/build/docs/MessagingRoutingTransferEvent.md +++ b/build/docs/MessagingRoutingTransferEvent.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingSetting.md b/build/docs/MessagingSetting.md index 4af03f4a2..35737faa9 100644 --- a/build/docs/MessagingSetting.md +++ b/build/docs/MessagingSetting.md @@ -20,4 +20,4 @@ Messaging setting for messaging platform integrations -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingSettingDefaultRequest.md b/build/docs/MessagingSettingDefaultRequest.md index 4d989a6e3..9e5501ae9 100644 --- a/build/docs/MessagingSettingDefaultRequest.md +++ b/build/docs/MessagingSettingDefaultRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingSettingPatchRequest.md b/build/docs/MessagingSettingPatchRequest.md index 382401aca..77cbd8d6f 100644 --- a/build/docs/MessagingSettingPatchRequest.md +++ b/build/docs/MessagingSettingPatchRequest.md @@ -15,4 +15,4 @@ Messaging setting for messaging platform integrations -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingSettingReference.md b/build/docs/MessagingSettingReference.md index 04d7b2d55..352c43708 100644 --- a/build/docs/MessagingSettingReference.md +++ b/build/docs/MessagingSettingReference.md @@ -20,4 +20,4 @@ Messaging Setting for messaging platform integrations -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingSettingRequest.md b/build/docs/MessagingSettingRequest.md index d48c2db55..af2254367 100644 --- a/build/docs/MessagingSettingRequest.md +++ b/build/docs/MessagingSettingRequest.md @@ -15,4 +15,4 @@ Messaging setting for messaging platform integrations -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingSettingRequestReference.md b/build/docs/MessagingSettingRequestReference.md index 086fce6fe..51975d9cd 100644 --- a/build/docs/MessagingSettingRequestReference.md +++ b/build/docs/MessagingSettingRequestReference.md @@ -11,4 +11,4 @@ Messaging Setting for messaging platform integrations -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingTemplate.md b/build/docs/MessagingTemplate.md index 4bec95eba..78d38133c 100644 --- a/build/docs/MessagingTemplate.md +++ b/build/docs/MessagingTemplate.md @@ -11,4 +11,4 @@ The messaging template identifies a structured message templates supported by a -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingUserEstablishedEvent.md b/build/docs/MessagingUserEstablishedEvent.md index 09ef93047..70d0b2052 100644 --- a/build/docs/MessagingUserEstablishedEvent.md +++ b/build/docs/MessagingUserEstablishedEvent.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessagingUserTransferEvent.md b/build/docs/MessagingUserTransferEvent.md index 99728cadb..702d05b41 100644 --- a/build/docs/MessagingUserTransferEvent.md +++ b/build/docs/MessagingUserTransferEvent.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessengerApps.md b/build/docs/MessengerApps.md index 5f0299a16..6c98bc101 100644 --- a/build/docs/MessengerApps.md +++ b/build/docs/MessengerApps.md @@ -12,4 +12,4 @@ The apps embedded in the messenger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessengerHomeScreen.md b/build/docs/MessengerHomeScreen.md index c1a14be62..6f5e7a0f3 100644 --- a/build/docs/MessengerHomeScreen.md +++ b/build/docs/MessengerHomeScreen.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessengerSettings.md b/build/docs/MessengerSettings.md index 7d15714f2..f2f8f62ff 100644 --- a/build/docs/MessengerSettings.md +++ b/build/docs/MessengerSettings.md @@ -17,4 +17,4 @@ Settings concerning messenger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MessengerStyles.md b/build/docs/MessengerStyles.md index 34afa39bb..6b5fe6091 100644 --- a/build/docs/MessengerStyles.md +++ b/build/docs/MessengerStyles.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetaData.md b/build/docs/MetaData.md index 408407626..6d04a3965 100644 --- a/build/docs/MetaData.md +++ b/build/docs/MetaData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Metabase.md b/build/docs/Metabase.md index a4181769d..efd016842 100644 --- a/build/docs/Metabase.md +++ b/build/docs/Metabase.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetadataAttribute.md b/build/docs/MetadataAttribute.md index adbf6488c..9045056e0 100644 --- a/build/docs/MetadataAttribute.md +++ b/build/docs/MetadataAttribute.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetadataDocumentation.md b/build/docs/MetadataDocumentation.md index a2f0de841..4ad96df95 100644 --- a/build/docs/MetadataDocumentation.md +++ b/build/docs/MetadataDocumentation.md @@ -12,4 +12,4 @@ Additional documentation about an artifact -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetadataItem.md b/build/docs/MetadataItem.md index d0dd4ef49..406a670d0 100644 --- a/build/docs/MetadataItem.md +++ b/build/docs/MetadataItem.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetadataPresentation.md b/build/docs/MetadataPresentation.md index dcdafe855..ef9792235 100644 --- a/build/docs/MetadataPresentation.md +++ b/build/docs/MetadataPresentation.md @@ -12,4 +12,4 @@ A representation of data fields to be gathered for installing the accelerator -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetadataProperty.md b/build/docs/MetadataProperty.md index e6cff6169..808b68595 100644 --- a/build/docs/MetadataProperty.md +++ b/build/docs/MetadataProperty.md @@ -17,4 +17,4 @@ Data property required as input for installing an accelerator -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetadataResultEntity.md b/build/docs/MetadataResultEntity.md index 09ec55084..968381cd7 100644 --- a/build/docs/MetadataResultEntity.md +++ b/build/docs/MetadataResultEntity.md @@ -13,4 +13,4 @@ A Genesys Cloud resource created or modified as a result of running an accelerat -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetadataResults.md b/build/docs/MetadataResults.md index 6ddefd827..70717da74 100644 --- a/build/docs/MetadataResults.md +++ b/build/docs/MetadataResults.md @@ -11,4 +11,4 @@ List of resources created or modified as a result of running an accelerator -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetadataSchema.md b/build/docs/MetadataSchema.md index a5eb7397e..bf7815c09 100644 --- a/build/docs/MetadataSchema.md +++ b/build/docs/MetadataSchema.md @@ -15,4 +15,4 @@ A description of the contents of a data gathering interface for an accelerator -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MeteredAssignmentByAgent.md b/build/docs/MeteredAssignmentByAgent.md index a817b335b..bd9a4e389 100644 --- a/build/docs/MeteredAssignmentByAgent.md +++ b/build/docs/MeteredAssignmentByAgent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MeteredEvaluationAssignment.md b/build/docs/MeteredEvaluationAssignment.md index d21d904e7..dcc1de779 100644 --- a/build/docs/MeteredEvaluationAssignment.md +++ b/build/docs/MeteredEvaluationAssignment.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Metric.md b/build/docs/Metric.md index b6981e051..95cfdebba 100644 --- a/build/docs/Metric.md +++ b/build/docs/Metric.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetricDefinition.md b/build/docs/MetricDefinition.md index 9085a81b4..19189f1ff 100644 --- a/build/docs/MetricDefinition.md +++ b/build/docs/MetricDefinition.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MetricValueTrendAverage.md b/build/docs/MetricValueTrendAverage.md index b2a43029d..3e9af9d5a 100644 --- a/build/docs/MetricValueTrendAverage.md +++ b/build/docs/MetricValueTrendAverage.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Metrics.md b/build/docs/Metrics.md index e30a3a583..1d054c44e 100644 --- a/build/docs/Metrics.md +++ b/build/docs/Metrics.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinLength.md b/build/docs/MinLength.md index aa4909a77..5bc135d73 100644 --- a/build/docs/MinLength.md +++ b/build/docs/MinLength.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinedIntentsListing.md b/build/docs/MinedIntentsListing.md index 6329f749c..802c5b059 100644 --- a/build/docs/MinedIntentsListing.md +++ b/build/docs/MinedIntentsListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Miner.md b/build/docs/Miner.md index 847943227..a108a66f3 100644 --- a/build/docs/Miner.md +++ b/build/docs/Miner.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinerErrorInfo.md b/build/docs/MinerErrorInfo.md index c2dc32573..5fd5c6eea 100644 --- a/build/docs/MinerErrorInfo.md +++ b/build/docs/MinerErrorInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinerExecuteRequest.md b/build/docs/MinerExecuteRequest.md index c58076203..1866e0f94 100644 --- a/build/docs/MinerExecuteRequest.md +++ b/build/docs/MinerExecuteRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinerIntent.md b/build/docs/MinerIntent.md index a5ce55b73..700f5b25f 100644 --- a/build/docs/MinerIntent.md +++ b/build/docs/MinerIntent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinerListing.md b/build/docs/MinerListing.md index aee48d787..c3d69f77d 100644 --- a/build/docs/MinerListing.md +++ b/build/docs/MinerListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinerTopic.md b/build/docs/MinerTopic.md index a43c1ea6e..08ea35adc 100644 --- a/build/docs/MinerTopic.md +++ b/build/docs/MinerTopic.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinerTopicPhrase.md b/build/docs/MinerTopicPhrase.md index a9dc9088d..b42ecfe10 100644 --- a/build/docs/MinerTopicPhrase.md +++ b/build/docs/MinerTopicPhrase.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MinerTopicsListing.md b/build/docs/MinerTopicsListing.md index 6055b28d3..7ac07ee11 100644 --- a/build/docs/MinerTopicsListing.md +++ b/build/docs/MinerTopicsListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MobileDevicesAPI.md b/build/docs/MobileDevicesAPI.md index 6792831a8..3b86e5d5f 100644 --- a/build/docs/MobileDevicesAPI.md +++ b/build/docs/MobileDevicesAPI.md @@ -262,4 +262,4 @@ MobileDevicesAPI.putMobiledevice(deviceId: deviceId, body: body) { (response, er [**UserDevice**](UserDevice) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ModifiableRuleProperties.md b/build/docs/ModifiableRuleProperties.md index 196a5342a..1c84b4755 100644 --- a/build/docs/ModifiableRuleProperties.md +++ b/build/docs/ModifiableRuleProperties.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MonthlyPlanningPeriodSettings.md b/build/docs/MonthlyPlanningPeriodSettings.md index ff0c19153..afd1276f6 100644 --- a/build/docs/MonthlyPlanningPeriodSettings.md +++ b/build/docs/MonthlyPlanningPeriodSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MoveAgentResponse.md b/build/docs/MoveAgentResponse.md index de9ef58af..e4f1ba7e1 100644 --- a/build/docs/MoveAgentResponse.md +++ b/build/docs/MoveAgentResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MoveAgentsRequest.md b/build/docs/MoveAgentsRequest.md index bcba1e0cf..e603cfc77 100644 --- a/build/docs/MoveAgentsRequest.md +++ b/build/docs/MoveAgentsRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MoveAgentsResponse.md b/build/docs/MoveAgentsResponse.md index 285b70871..3a4f64e75 100644 --- a/build/docs/MoveAgentsResponse.md +++ b/build/docs/MoveAgentsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MoveManagementUnitRequest.md b/build/docs/MoveManagementUnitRequest.md index b7f1bb80f..67d35ef4a 100644 --- a/build/docs/MoveManagementUnitRequest.md +++ b/build/docs/MoveManagementUnitRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MoveManagementUnitResponse.md b/build/docs/MoveManagementUnitResponse.md index 40f262559..02c19b692 100644 --- a/build/docs/MoveManagementUnitResponse.md +++ b/build/docs/MoveManagementUnitResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MuAgentQueueTimeRequest.md b/build/docs/MuAgentQueueTimeRequest.md index 7ac729936..453c6d5b4 100644 --- a/build/docs/MuAgentQueueTimeRequest.md +++ b/build/docs/MuAgentQueueTimeRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MuAgentsWorkPlansResult.md b/build/docs/MuAgentsWorkPlansResult.md index 2c73b2445..b66f96c1e 100644 --- a/build/docs/MuAgentsWorkPlansResult.md +++ b/build/docs/MuAgentsWorkPlansResult.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MuRescheduleResultWrapper.md b/build/docs/MuRescheduleResultWrapper.md index adb6c8d26..c5813156c 100644 --- a/build/docs/MuRescheduleResultWrapper.md +++ b/build/docs/MuRescheduleResultWrapper.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MutableUserPresence.md b/build/docs/MutableUserPresence.md index 656146e5f..3ae1e4bd8 100644 --- a/build/docs/MutableUserPresence.md +++ b/build/docs/MutableUserPresence.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/MuteSnoozeFields.md b/build/docs/MuteSnoozeFields.md index 94f1cf624..86bfa1950 100644 --- a/build/docs/MuteSnoozeFields.md +++ b/build/docs/MuteSnoozeFields.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NTPSettings.md b/build/docs/NTPSettings.md index 1248143a7..957225e36 100644 --- a/build/docs/NTPSettings.md +++ b/build/docs/NTPSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamedEntity.md b/build/docs/NamedEntity.md index b9951c66a..7b5fefb28 100644 --- a/build/docs/NamedEntity.md +++ b/build/docs/NamedEntity.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamedEntityAnnotation.md b/build/docs/NamedEntityAnnotation.md index 28fb0269a..c07776b3b 100644 --- a/build/docs/NamedEntityAnnotation.md +++ b/build/docs/NamedEntityAnnotation.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamedEntityDefinition.md b/build/docs/NamedEntityDefinition.md index 8c5f81d68..52e9053f9 100644 --- a/build/docs/NamedEntityDefinition.md +++ b/build/docs/NamedEntityDefinition.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamedEntityTypeBinding.md b/build/docs/NamedEntityTypeBinding.md index 20929b49e..c24edfa92 100644 --- a/build/docs/NamedEntityTypeBinding.md +++ b/build/docs/NamedEntityTypeBinding.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamedEntityTypeDefinition.md b/build/docs/NamedEntityTypeDefinition.md index 2993ddfbe..7d07e2684 100644 --- a/build/docs/NamedEntityTypeDefinition.md +++ b/build/docs/NamedEntityTypeDefinition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamedEntityTypeItem.md b/build/docs/NamedEntityTypeItem.md index a47e6e75a..351f62be1 100644 --- a/build/docs/NamedEntityTypeItem.md +++ b/build/docs/NamedEntityTypeItem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamedEntityTypeMechanism.md b/build/docs/NamedEntityTypeMechanism.md index 318b13ce8..9ef1f7b36 100644 --- a/build/docs/NamedEntityTypeMechanism.md +++ b/build/docs/NamedEntityTypeMechanism.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamedEntityTypeMechanismExample.md b/build/docs/NamedEntityTypeMechanismExample.md index 5131b8f28..07358a053 100644 --- a/build/docs/NamedEntityTypeMechanismExample.md +++ b/build/docs/NamedEntityTypeMechanismExample.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NamespaceDocs.md b/build/docs/NamespaceDocs.md index 140289446..3dbac011b 100644 --- a/build/docs/NamespaceDocs.md +++ b/build/docs/NamespaceDocs.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NetworkConnectivity.md b/build/docs/NetworkConnectivity.md index dc21124ba..b7651e2ea 100644 --- a/build/docs/NetworkConnectivity.md +++ b/build/docs/NetworkConnectivity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NextOccurrenceDetails.md b/build/docs/NextOccurrenceDetails.md index b93cefd50..3e07dd2df 100644 --- a/build/docs/NextOccurrenceDetails.md +++ b/build/docs/NextOccurrenceDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluConfig.md b/build/docs/NluConfig.md index 173ca6eaf..618972f03 100644 --- a/build/docs/NluConfig.md +++ b/build/docs/NluConfig.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluConfusionMatrixColumn.md b/build/docs/NluConfusionMatrixColumn.md index d2306ae90..f32ca3079 100644 --- a/build/docs/NluConfusionMatrixColumn.md +++ b/build/docs/NluConfusionMatrixColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluConfusionMatrixRow.md b/build/docs/NluConfusionMatrixRow.md index 444c60bfb..8efbd69dd 100644 --- a/build/docs/NluConfusionMatrixRow.md +++ b/build/docs/NluConfusionMatrixRow.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDetectionContext.md b/build/docs/NluDetectionContext.md index ec889a2a0..a5ae3922f 100644 --- a/build/docs/NluDetectionContext.md +++ b/build/docs/NluDetectionContext.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDetectionInput.md b/build/docs/NluDetectionInput.md index 253406e76..5874fef85 100644 --- a/build/docs/NluDetectionInput.md +++ b/build/docs/NluDetectionInput.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDetectionOutput.md b/build/docs/NluDetectionOutput.md index a53b73b43..cb171d124 100644 --- a/build/docs/NluDetectionOutput.md +++ b/build/docs/NluDetectionOutput.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDetectionRequest.md b/build/docs/NluDetectionRequest.md index f09aa7f79..9bd92ad95 100644 --- a/build/docs/NluDetectionRequest.md +++ b/build/docs/NluDetectionRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDetectionResponse.md b/build/docs/NluDetectionResponse.md index 9e3f36a3a..54e95f8ae 100644 --- a/build/docs/NluDetectionResponse.md +++ b/build/docs/NluDetectionResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDomain.md b/build/docs/NluDomain.md index 32dca82f5..d38ecdd94 100644 --- a/build/docs/NluDomain.md +++ b/build/docs/NluDomain.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDomainListing.md b/build/docs/NluDomainListing.md index 41a02f2dd..6983ebf97 100644 --- a/build/docs/NluDomainListing.md +++ b/build/docs/NluDomainListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDomainVersion.md b/build/docs/NluDomainVersion.md index 74bf82cd0..bdafdc488 100644 --- a/build/docs/NluDomainVersion.md +++ b/build/docs/NluDomainVersion.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDomainVersionListing.md b/build/docs/NluDomainVersionListing.md index 0ee670b18..e801f257e 100644 --- a/build/docs/NluDomainVersionListing.md +++ b/build/docs/NluDomainVersionListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDomainVersionQualityReport.md b/build/docs/NluDomainVersionQualityReport.md index bacff91f9..7ca43f1c9 100644 --- a/build/docs/NluDomainVersionQualityReport.md +++ b/build/docs/NluDomainVersionQualityReport.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluDomainVersionTrainingResponse.md b/build/docs/NluDomainVersionTrainingResponse.md index 41f80502f..3322efd56 100644 --- a/build/docs/NluDomainVersionTrainingResponse.md +++ b/build/docs/NluDomainVersionTrainingResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluFeedbackListing.md b/build/docs/NluFeedbackListing.md index c141407a2..c3f9905c5 100644 --- a/build/docs/NluFeedbackListing.md +++ b/build/docs/NluFeedbackListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluFeedbackRequest.md b/build/docs/NluFeedbackRequest.md index 7a83ab787..8086beb3c 100644 --- a/build/docs/NluFeedbackRequest.md +++ b/build/docs/NluFeedbackRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluFeedbackResponse.md b/build/docs/NluFeedbackResponse.md index 46c86b230..d0b4167a0 100644 --- a/build/docs/NluFeedbackResponse.md +++ b/build/docs/NluFeedbackResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluInfo.md b/build/docs/NluInfo.md index d06ed3b03..078288862 100644 --- a/build/docs/NluInfo.md +++ b/build/docs/NluInfo.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluQualityReportSummary.md b/build/docs/NluQualityReportSummary.md index 22dc92daa..ed7074924 100644 --- a/build/docs/NluQualityReportSummary.md +++ b/build/docs/NluQualityReportSummary.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluQualityReportSummaryMetric.md b/build/docs/NluQualityReportSummaryMetric.md index d40cd70f4..f316273c1 100644 --- a/build/docs/NluQualityReportSummaryMetric.md +++ b/build/docs/NluQualityReportSummaryMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluUtterance.md b/build/docs/NluUtterance.md index 1d71f0c45..de99b08f4 100644 --- a/build/docs/NluUtterance.md +++ b/build/docs/NluUtterance.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NluUtteranceSegment.md b/build/docs/NluUtteranceSegment.md index 031fcac51..df0ddcdee 100644 --- a/build/docs/NluUtteranceSegment.md +++ b/build/docs/NluUtteranceSegment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Note.md b/build/docs/Note.md index ad5b2b265..537e38c7c 100644 --- a/build/docs/Note.md +++ b/build/docs/Note.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NoteListing.md b/build/docs/NoteListing.md index e42b337b2..6672e5a4e 100644 --- a/build/docs/NoteListing.md +++ b/build/docs/NoteListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **partialResults** | **Bool** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NotificationTemplateBody.md b/build/docs/NotificationTemplateBody.md index d0416a7c2..c9d9500d8 100644 --- a/build/docs/NotificationTemplateBody.md +++ b/build/docs/NotificationTemplateBody.md @@ -12,4 +12,4 @@ Template body object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NotificationTemplateFooter.md b/build/docs/NotificationTemplateFooter.md index dfad9f82a..66e67106f 100644 --- a/build/docs/NotificationTemplateFooter.md +++ b/build/docs/NotificationTemplateFooter.md @@ -11,4 +11,4 @@ Template footer object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NotificationTemplateHeader.md b/build/docs/NotificationTemplateHeader.md index d0a6e0034..dff3b3808 100644 --- a/build/docs/NotificationTemplateHeader.md +++ b/build/docs/NotificationTemplateHeader.md @@ -14,4 +14,4 @@ Template header object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NotificationTemplateParameter.md b/build/docs/NotificationTemplateParameter.md index 7d170c010..649052647 100644 --- a/build/docs/NotificationTemplateParameter.md +++ b/build/docs/NotificationTemplateParameter.md @@ -12,4 +12,4 @@ Template parameters for placeholders in template. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NotificationsAPI.md b/build/docs/NotificationsAPI.md index e12558f60..897ed5a9b 100644 --- a/build/docs/NotificationsAPI.md +++ b/build/docs/NotificationsAPI.md @@ -415,4 +415,4 @@ NotificationsAPI.putNotificationsChannelSubscriptions(channelId: channelId, body [**ChannelTopicEntityListing**](ChannelTopicEntityListing) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NotificationsResponse.md b/build/docs/NotificationsResponse.md index 6bb43f665..505a85e21 100644 --- a/build/docs/NotificationsResponse.md +++ b/build/docs/NotificationsResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NotificationsSettings.md b/build/docs/NotificationsSettings.md index 788c16a7f..8d738f736 100644 --- a/build/docs/NotificationsSettings.md +++ b/build/docs/NotificationsSettings.md @@ -11,4 +11,4 @@ Notification settings that handles messenger notifications -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceApplication.md b/build/docs/NuanceApplication.md index 3ebe62e2f..f65e7236b 100644 --- a/build/docs/NuanceApplication.md +++ b/build/docs/NuanceApplication.md @@ -13,4 +13,4 @@ Model for a Nuance bot application -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceBot.md b/build/docs/NuanceBot.md index dccb9077c..83609feea 100644 --- a/build/docs/NuanceBot.md +++ b/build/docs/NuanceBot.md @@ -23,4 +23,4 @@ Model for a Nuance bot -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceBotCredentials.md b/build/docs/NuanceBotCredentials.md index 30d2f1d03..41544fb3c 100644 --- a/build/docs/NuanceBotCredentials.md +++ b/build/docs/NuanceBotCredentials.md @@ -14,4 +14,4 @@ Model for a Nuance bot credentials -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceBotEntityListing.md b/build/docs/NuanceBotEntityListing.md index dfded6524..713146a5d 100644 --- a/build/docs/NuanceBotEntityListing.md +++ b/build/docs/NuanceBotEntityListing.md @@ -11,13 +11,13 @@ Model for a paged listing of Nuance bots | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceBotLaunchSettings.md b/build/docs/NuanceBotLaunchSettings.md index 33b49c0d9..2139e6c9d 100644 --- a/build/docs/NuanceBotLaunchSettings.md +++ b/build/docs/NuanceBotLaunchSettings.md @@ -11,4 +11,4 @@ Model for setting the launch configuration for Nuance bots available to Genesys -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceBotTransferNode.md b/build/docs/NuanceBotTransferNode.md index 5784c06fe..81016594b 100644 --- a/build/docs/NuanceBotTransferNode.md +++ b/build/docs/NuanceBotTransferNode.md @@ -15,4 +15,4 @@ Model for a Nuance bot transfer node -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceBotVariable.md b/build/docs/NuanceBotVariable.md index 3516ad427..0e21bc11f 100644 --- a/build/docs/NuanceBotVariable.md +++ b/build/docs/NuanceBotVariable.md @@ -16,4 +16,4 @@ Model for a Nuance bot variable -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceChannel.md b/build/docs/NuanceChannel.md index ab21ba0e6..04d449921 100644 --- a/build/docs/NuanceChannel.md +++ b/build/docs/NuanceChannel.md @@ -14,4 +14,4 @@ Model for a Nuance channel -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceEnvironment.md b/build/docs/NuanceEnvironment.md index dee5d3c9d..aae84d45b 100644 --- a/build/docs/NuanceEnvironment.md +++ b/build/docs/NuanceEnvironment.md @@ -14,4 +14,4 @@ Model for a Nuance bot environment -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceGeography.md b/build/docs/NuanceGeography.md index 9e46141a9..d9aa82755 100644 --- a/build/docs/NuanceGeography.md +++ b/build/docs/NuanceGeography.md @@ -12,4 +12,4 @@ Model for a Nuance bot geography -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceMixDlgSettings.md b/build/docs/NuanceMixDlgSettings.md index 7cfef4596..4c56c15c4 100644 --- a/build/docs/NuanceMixDlgSettings.md +++ b/build/docs/NuanceMixDlgSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NuanceOrganization.md b/build/docs/NuanceOrganization.md index da04f9fd9..3691bfee0 100644 --- a/build/docs/NuanceOrganization.md +++ b/build/docs/NuanceOrganization.md @@ -12,4 +12,4 @@ Model for a Nuance bot organization -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Number.md b/build/docs/Number.md index 75c5ce792..1bce9e885 100644 --- a/build/docs/Number.md +++ b/build/docs/Number.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NumberPlan.md b/build/docs/NumberPlan.md index eb43f769a..defb303ec 100644 --- a/build/docs/NumberPlan.md +++ b/build/docs/NumberPlan.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/NumericRange.md b/build/docs/NumericRange.md index 923d5d3f1..40860dbfa 100644 --- a/build/docs/NumericRange.md +++ b/build/docs/NumericRange.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthAPI.md b/build/docs/OAuthAPI.md index bf50cfd0b..6fe490968 100644 --- a/build/docs/OAuthAPI.md +++ b/build/docs/OAuthAPI.md @@ -686,4 +686,4 @@ OAuthAPI.putOauthClient(clientId: clientId, body: body) { (response, error) in [**OAuthClient**](OAuthClient) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthAuthorization.md b/build/docs/OAuthAuthorization.md index 1aa89ac06..f2c4e41b1 100644 --- a/build/docs/OAuthAuthorization.md +++ b/build/docs/OAuthAuthorization.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthAuthorizationListing.md b/build/docs/OAuthAuthorizationListing.md index c383600d4..3234998b9 100644 --- a/build/docs/OAuthAuthorizationListing.md +++ b/build/docs/OAuthAuthorizationListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthClient.md b/build/docs/OAuthClient.md index 8c5ce2f5a..dc2f6245f 100644 --- a/build/docs/OAuthClient.md +++ b/build/docs/OAuthClient.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthClientEntityListing.md b/build/docs/OAuthClientEntityListing.md index e8a8503e1..8391dce31 100644 --- a/build/docs/OAuthClientEntityListing.md +++ b/build/docs/OAuthClientEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthClientListing.md b/build/docs/OAuthClientListing.md index 74781e6aa..13d34ddd9 100644 --- a/build/docs/OAuthClientListing.md +++ b/build/docs/OAuthClientListing.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthClientRequest.md b/build/docs/OAuthClientRequest.md index 44b9e10f8..2e057d775 100644 --- a/build/docs/OAuthClientRequest.md +++ b/build/docs/OAuthClientRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthLastTokenIssued.md b/build/docs/OAuthLastTokenIssued.md index 39abd7421..be7f71035 100644 --- a/build/docs/OAuthLastTokenIssued.md +++ b/build/docs/OAuthLastTokenIssued.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthScope.md b/build/docs/OAuthScope.md index 82f662ff4..84ae3de44 100644 --- a/build/docs/OAuthScope.md +++ b/build/docs/OAuthScope.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OAuthScopeListing.md b/build/docs/OAuthScopeListing.md index c53d4c7d7..785e5127c 100644 --- a/build/docs/OAuthScopeListing.md +++ b/build/docs/OAuthScopeListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Objective.md b/build/docs/Objective.md index 1f7f76b48..db6ec2317 100644 --- a/build/docs/Objective.md +++ b/build/docs/Objective.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ObjectiveTemplate.md b/build/docs/ObjectiveTemplate.md index f3d4434b7..b46effc71 100644 --- a/build/docs/ObjectiveTemplate.md +++ b/build/docs/ObjectiveTemplate.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ObjectiveZone.md b/build/docs/ObjectiveZone.md index 06780bdc1..f6aad819f 100644 --- a/build/docs/ObjectiveZone.md +++ b/build/docs/ObjectiveZone.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ObjectsAPI.md b/build/docs/ObjectsAPI.md index 00e523cc2..bb0001b5c 100644 --- a/build/docs/ObjectsAPI.md +++ b/build/docs/ObjectsAPI.md @@ -486,4 +486,4 @@ ObjectsAPI.putAuthorizationDivision(divisionId: divisionId, body: body) { (respo [**AuthzDivision**](AuthzDivision) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ObservationMetricData.md b/build/docs/ObservationMetricData.md index 7f8d09188..b473c0406 100644 --- a/build/docs/ObservationMetricData.md +++ b/build/docs/ObservationMetricData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ObservationValue.md b/build/docs/ObservationValue.md index 0b0ef2b7f..5b2fff7cb 100644 --- a/build/docs/ObservationValue.md +++ b/build/docs/ObservationValue.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OccurrenceDetails.md b/build/docs/OccurrenceDetails.md index 754d5d3c8..bd494f211 100644 --- a/build/docs/OccurrenceDetails.md +++ b/build/docs/OccurrenceDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Okta.md b/build/docs/Okta.md index c5780837c..93a25640c 100644 --- a/build/docs/Okta.md +++ b/build/docs/Okta.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OneLogin.md b/build/docs/OneLogin.md index 5449f6f42..3045a3c0c 100644 --- a/build/docs/OneLogin.md +++ b/build/docs/OneLogin.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenActionFields.md b/build/docs/OpenActionFields.md index 2b744b12f..010954976 100644 --- a/build/docs/OpenActionFields.md +++ b/build/docs/OpenActionFields.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenActionProperties.md b/build/docs/OpenActionProperties.md index 974c80cd9..2a06e7a67 100644 --- a/build/docs/OpenActionProperties.md +++ b/build/docs/OpenActionProperties.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenContentAttachment.md b/build/docs/OpenContentAttachment.md index 266cb8aff..ef8ca3725 100644 --- a/build/docs/OpenContentAttachment.md +++ b/build/docs/OpenContentAttachment.md @@ -17,4 +17,4 @@ Attachment object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenEvent.md b/build/docs/OpenEvent.md index ab1602b14..c2119c389 100644 --- a/build/docs/OpenEvent.md +++ b/build/docs/OpenEvent.md @@ -11,4 +11,4 @@ Message event element. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenEventNormalizedMessage.md b/build/docs/OpenEventNormalizedMessage.md index ea0eabdd5..fe2d99e67 100644 --- a/build/docs/OpenEventNormalizedMessage.md +++ b/build/docs/OpenEventNormalizedMessage.md @@ -14,4 +14,4 @@ Open Messaging rich media message structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenInboundMessageContent.md b/build/docs/OpenInboundMessageContent.md index e8ca9ab49..6141d240d 100644 --- a/build/docs/OpenInboundMessageContent.md +++ b/build/docs/OpenInboundMessageContent.md @@ -11,4 +11,4 @@ Message content element. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenInboundMessageMessagingChannel.md b/build/docs/OpenInboundMessageMessagingChannel.md index e411cc0d6..813826c69 100644 --- a/build/docs/OpenInboundMessageMessagingChannel.md +++ b/build/docs/OpenInboundMessageMessagingChannel.md @@ -14,4 +14,4 @@ Open Channel-specific information that describes the message and the message cha -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenInboundMessagingChannel.md b/build/docs/OpenInboundMessagingChannel.md index 2b1133b22..58b96d119 100644 --- a/build/docs/OpenInboundMessagingChannel.md +++ b/build/docs/OpenInboundMessagingChannel.md @@ -12,4 +12,4 @@ Open Channel-specific information that describes the message and the message cha -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenInboundMessagingReceiptChannel.md b/build/docs/OpenInboundMessagingReceiptChannel.md index 5eb186c8b..10548a611 100644 --- a/build/docs/OpenInboundMessagingReceiptChannel.md +++ b/build/docs/OpenInboundMessagingReceiptChannel.md @@ -12,4 +12,4 @@ Open Channel-specific information that describes the message and the message cha -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenInboundNormalizedEvent.md b/build/docs/OpenInboundNormalizedEvent.md index 99ba84642..82faf31b2 100644 --- a/build/docs/OpenInboundNormalizedEvent.md +++ b/build/docs/OpenInboundNormalizedEvent.md @@ -12,4 +12,4 @@ Open Event Messaging rich media message structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenInboundNormalizedMessage.md b/build/docs/OpenInboundNormalizedMessage.md index b54bd1edd..cec569bec 100644 --- a/build/docs/OpenInboundNormalizedMessage.md +++ b/build/docs/OpenInboundNormalizedMessage.md @@ -14,4 +14,4 @@ Open Messaging rich media message structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenInboundNormalizedReceipt.md b/build/docs/OpenInboundNormalizedReceipt.md index 61db0805a..bf8c653d0 100644 --- a/build/docs/OpenInboundNormalizedReceipt.md +++ b/build/docs/OpenInboundNormalizedReceipt.md @@ -15,4 +15,4 @@ Open Messaging rich media message structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenIntegration.md b/build/docs/OpenIntegration.md index 70fa6f910..a0aa6d45b 100644 --- a/build/docs/OpenIntegration.md +++ b/build/docs/OpenIntegration.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenIntegrationEntityListing.md b/build/docs/OpenIntegrationEntityListing.md index eaeb09814..a05b6c720 100644 --- a/build/docs/OpenIntegrationEntityListing.md +++ b/build/docs/OpenIntegrationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenIntegrationRequest.md b/build/docs/OpenIntegrationRequest.md index a66d0217a..6e3c7c932 100644 --- a/build/docs/OpenIntegrationRequest.md +++ b/build/docs/OpenIntegrationRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenIntegrationUpdateRequest.md b/build/docs/OpenIntegrationUpdateRequest.md index c872ef43c..88364d3e1 100644 --- a/build/docs/OpenIntegrationUpdateRequest.md +++ b/build/docs/OpenIntegrationUpdateRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenMessageContent.md b/build/docs/OpenMessageContent.md index 6f1745f13..cbed1081b 100644 --- a/build/docs/OpenMessageContent.md +++ b/build/docs/OpenMessageContent.md @@ -12,4 +12,4 @@ Message content element. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenMessageEvent.md b/build/docs/OpenMessageEvent.md index 02956ac8a..61f033dcc 100644 --- a/build/docs/OpenMessageEvent.md +++ b/build/docs/OpenMessageEvent.md @@ -12,4 +12,4 @@ Message event element. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenMessageNormalizedMessage.md b/build/docs/OpenMessageNormalizedMessage.md index 2277c3942..dd66aa043 100644 --- a/build/docs/OpenMessageNormalizedMessage.md +++ b/build/docs/OpenMessageNormalizedMessage.md @@ -17,4 +17,4 @@ Open Messaging rich media message structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenMessagingChannel.md b/build/docs/OpenMessagingChannel.md index 3c193bda3..c1897b5c6 100644 --- a/build/docs/OpenMessagingChannel.md +++ b/build/docs/OpenMessagingChannel.md @@ -18,4 +18,4 @@ Channel-specific information that describes the message and the message channel/ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenMessagingFromRecipient.md b/build/docs/OpenMessagingFromRecipient.md index 0e97597d1..bf8a228e0 100644 --- a/build/docs/OpenMessagingFromRecipient.md +++ b/build/docs/OpenMessagingFromRecipient.md @@ -17,4 +17,4 @@ Information about the recipient the message is received from. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenMessagingIdentityResolutionConfig.md b/build/docs/OpenMessagingIdentityResolutionConfig.md index 5f395fe87..e2931ad19 100644 --- a/build/docs/OpenMessagingIdentityResolutionConfig.md +++ b/build/docs/OpenMessagingIdentityResolutionConfig.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenMessagingToRecipient.md b/build/docs/OpenMessagingToRecipient.md index 71d871efe..d7c4922a0 100644 --- a/build/docs/OpenMessagingToRecipient.md +++ b/build/docs/OpenMessagingToRecipient.md @@ -17,4 +17,4 @@ Information about the recipient the message is sent to. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenNormalizedMessage.md b/build/docs/OpenNormalizedMessage.md index bbc640b73..6f37c8401 100644 --- a/build/docs/OpenNormalizedMessage.md +++ b/build/docs/OpenNormalizedMessage.md @@ -20,4 +20,4 @@ Open Messaging rich media message structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OpenReceiptNormalizedMessage.md b/build/docs/OpenReceiptNormalizedMessage.md index 27f7cc1fe..0ca379897 100644 --- a/build/docs/OpenReceiptNormalizedMessage.md +++ b/build/docs/OpenReceiptNormalizedMessage.md @@ -17,4 +17,4 @@ Open Messaging rich media message structure -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Operand.md b/build/docs/Operand.md index 1331b651b..faced4ff6 100644 --- a/build/docs/Operand.md +++ b/build/docs/Operand.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperandPosition.md b/build/docs/OperandPosition.md index 43d2541ab..382042677 100644 --- a/build/docs/OperandPosition.md +++ b/build/docs/OperandPosition.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Operation.md b/build/docs/Operation.md index a67c71d60..9c5212305 100644 --- a/build/docs/Operation.md +++ b/build/docs/Operation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperationCreatorUserResponse.md b/build/docs/OperationCreatorUserResponse.md index 42dbc683e..26b65826d 100644 --- a/build/docs/OperationCreatorUserResponse.md +++ b/build/docs/OperationCreatorUserResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperationListing.md b/build/docs/OperationListing.md index 05a92dfa1..d2bc8ba9c 100644 --- a/build/docs/OperationListing.md +++ b/build/docs/OperationListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperationResponse.md b/build/docs/OperationResponse.md index 3344ae3de..e303b03d9 100644 --- a/build/docs/OperationResponse.md +++ b/build/docs/OperationResponse.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperationalEvent.md b/build/docs/OperationalEvent.md index 4278d94a0..d9e1197ec 100644 --- a/build/docs/OperationalEvent.md +++ b/build/docs/OperationalEvent.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperationalEventNotificationTopicEventEntity.md b/build/docs/OperationalEventNotificationTopicEventEntity.md index e4dd652d5..60f1bb46b 100644 --- a/build/docs/OperationalEventNotificationTopicEventEntity.md +++ b/build/docs/OperationalEventNotificationTopicEventEntity.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperationalEventNotificationTopicOperationalEventNotification.md b/build/docs/OperationalEventNotificationTopicOperationalEventNotification.md index c42ba73d7..f7aedffce 100644 --- a/build/docs/OperationalEventNotificationTopicOperationalEventNotification.md +++ b/build/docs/OperationalEventNotificationTopicOperationalEventNotification.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperationalEventsAPI.md b/build/docs/OperationalEventsAPI.md index f98ecf1ef..a2d76dd60 100644 --- a/build/docs/OperationalEventsAPI.md +++ b/build/docs/OperationalEventsAPI.md @@ -213,4 +213,4 @@ OperationalEventsAPI.postUsageEventsQuery(before: before, after: after, pageSize [**EventQueryResponse**](EventQueryResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OperatorPosition.md b/build/docs/OperatorPosition.md index 502e8bffc..fea183bd9 100644 --- a/build/docs/OperatorPosition.md +++ b/build/docs/OperatorPosition.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OptInSettings.md b/build/docs/OptInSettings.md index be3a09f26..66e17afa1 100644 --- a/build/docs/OptInSettings.md +++ b/build/docs/OptInSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrgAuthSettings.md b/build/docs/OrgAuthSettings.md index 0e571181c..c9a36a45c 100644 --- a/build/docs/OrgAuthSettings.md +++ b/build/docs/OrgAuthSettings.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrgOAuthClient.md b/build/docs/OrgOAuthClient.md index 50acbff73..eb462dd28 100644 --- a/build/docs/OrgOAuthClient.md +++ b/build/docs/OrgOAuthClient.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrgUser.md b/build/docs/OrgUser.md index c3192b39a..427455af7 100644 --- a/build/docs/OrgUser.md +++ b/build/docs/OrgUser.md @@ -47,4 +47,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrgWhitelistSettings.md b/build/docs/OrgWhitelistSettings.md index d13b3963a..64b5a68d5 100644 --- a/build/docs/OrgWhitelistSettings.md +++ b/build/docs/OrgWhitelistSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Organization.md b/build/docs/Organization.md index 3f0110d3c..e521a97a4 100644 --- a/build/docs/Organization.md +++ b/build/docs/Organization.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationAPI.md b/build/docs/OrganizationAPI.md index 2a42615df..fce9b223a 100644 --- a/build/docs/OrganizationAPI.md +++ b/build/docs/OrganizationAPI.md @@ -1081,4 +1081,4 @@ OrganizationAPI.putOrganizationsWhitelist(body: body) { (response, error) in [**OrgWhitelistSettings**](OrgWhitelistSettings) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationAuthorizationAPI.md b/build/docs/OrganizationAuthorizationAPI.md index f372be04a..92d15fcb2 100644 --- a/build/docs/OrganizationAuthorizationAPI.md +++ b/build/docs/OrganizationAuthorizationAPI.md @@ -2445,4 +2445,4 @@ OrganizationAuthorizationAPI.putOrgauthorizationTrustorUser(trustorOrgId: trusto [**TrustUser**](TrustUser) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationFeatures.md b/build/docs/OrganizationFeatures.md index 4b0bc89de..764e5e640 100644 --- a/build/docs/OrganizationFeatures.md +++ b/build/docs/OrganizationFeatures.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationPresence.md b/build/docs/OrganizationPresence.md index f617564a2..546e298d0 100644 --- a/build/docs/OrganizationPresence.md +++ b/build/docs/OrganizationPresence.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationPresenceDefinition.md b/build/docs/OrganizationPresenceDefinition.md index 8c6fcfa61..e2435195d 100644 --- a/build/docs/OrganizationPresenceDefinition.md +++ b/build/docs/OrganizationPresenceDefinition.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationPresenceDefinitionEntityListing.md b/build/docs/OrganizationPresenceDefinitionEntityListing.md index d6a42d759..67cb9a39d 100644 --- a/build/docs/OrganizationPresenceDefinitionEntityListing.md +++ b/build/docs/OrganizationPresenceDefinitionEntityListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationPresenceEntityListing.md b/build/docs/OrganizationPresenceEntityListing.md index 349d089d1..181d35433 100644 --- a/build/docs/OrganizationPresenceEntityListing.md +++ b/build/docs/OrganizationPresenceEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationProductEntityListing.md b/build/docs/OrganizationProductEntityListing.md index 520be1ad4..56133ae1e 100644 --- a/build/docs/OrganizationProductEntityListing.md +++ b/build/docs/OrganizationProductEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrganizationRoleEntityListing.md b/build/docs/OrganizationRoleEntityListing.md index 50e5ad42c..089ec0656 100644 --- a/build/docs/OrganizationRoleEntityListing.md +++ b/build/docs/OrganizationRoleEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrphanRecording.md b/build/docs/OrphanRecording.md index 3a2edcb4a..2b13c2f71 100644 --- a/build/docs/OrphanRecording.md +++ b/build/docs/OrphanRecording.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrphanRecordingListing.md b/build/docs/OrphanRecordingListing.md index b7dc6ad61..95fd512de 100644 --- a/build/docs/OrphanRecordingListing.md +++ b/build/docs/OrphanRecordingListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OrphanUpdateRequest.md b/build/docs/OrphanUpdateRequest.md index b9184246f..777d60ae3 100644 --- a/build/docs/OrphanUpdateRequest.md +++ b/build/docs/OrphanUpdateRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OtherProfileAssignment.md b/build/docs/OtherProfileAssignment.md index 5359578c3..1343a881f 100644 --- a/build/docs/OtherProfileAssignment.md +++ b/build/docs/OtherProfileAssignment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutOfOffice.md b/build/docs/OutOfOffice.md index 94d26c5e4..df555848f 100644 --- a/build/docs/OutOfOffice.md +++ b/build/docs/OutOfOffice.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutOfOfficeEventOutOfOffice.md b/build/docs/OutOfOfficeEventOutOfOffice.md index 837131a17..9c7d566d9 100644 --- a/build/docs/OutOfOfficeEventOutOfOffice.md +++ b/build/docs/OutOfOfficeEventOutOfOffice.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutOfOfficeEventUser.md b/build/docs/OutOfOfficeEventUser.md index 8cf301be5..84d1be229 100644 --- a/build/docs/OutOfOfficeEventUser.md +++ b/build/docs/OutOfOfficeEventUser.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundAPI.md b/build/docs/OutboundAPI.md index 934e33474..5d1a91938 100644 --- a/build/docs/OutboundAPI.md +++ b/build/docs/OutboundAPI.md @@ -8926,4 +8926,4 @@ OutboundAPI.putOutboundWrapupcodemappings(body: body) { (response, error) in [**WrapUpCodeMapping**](WrapUpCodeMapping) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundDetailEventTopicOutboundInitEvent.md b/build/docs/OutboundDetailEventTopicOutboundInitEvent.md index 21945eb0a..5b0c45457 100644 --- a/build/docs/OutboundDetailEventTopicOutboundInitEvent.md +++ b/build/docs/OutboundDetailEventTopicOutboundInitEvent.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundDomain.md b/build/docs/OutboundDomain.md index 14e048672..e24937db5 100644 --- a/build/docs/OutboundDomain.md +++ b/build/docs/OutboundDomain.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundDomainEntityListing.md b/build/docs/OutboundDomainEntityListing.md index e5518cf0c..b148a9e7d 100644 --- a/build/docs/OutboundDomainEntityListing.md +++ b/build/docs/OutboundDomainEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingCampaignPostContactEmailEventTopicEmailAttributes.md b/build/docs/OutboundMessagingCampaignPostContactEmailEventTopicEmailAttributes.md index f20e0d43d..5e447c045 100644 --- a/build/docs/OutboundMessagingCampaignPostContactEmailEventTopicEmailAttributes.md +++ b/build/docs/OutboundMessagingCampaignPostContactEmailEventTopicEmailAttributes.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingCampaignPostContactEmailEventTopicOutboundMessagingCampaignPostContactEmailEvent.md b/build/docs/OutboundMessagingCampaignPostContactEmailEventTopicOutboundMessagingCampaignPostContactEmailEvent.md index 061d0cf1c..5a1911eba 100644 --- a/build/docs/OutboundMessagingCampaignPostContactEmailEventTopicOutboundMessagingCampaignPostContactEmailEvent.md +++ b/build/docs/OutboundMessagingCampaignPostContactEmailEventTopicOutboundMessagingCampaignPostContactEmailEvent.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingCampaignPostContactSmsEventTopicOutboundMessagingCampaignPostContactSMSEvent.md b/build/docs/OutboundMessagingCampaignPostContactSmsEventTopicOutboundMessagingCampaignPostContactSMSEvent.md index 03d4a1223..00663058f 100644 --- a/build/docs/OutboundMessagingCampaignPostContactSmsEventTopicOutboundMessagingCampaignPostContactSMSEvent.md +++ b/build/docs/OutboundMessagingCampaignPostContactSmsEventTopicOutboundMessagingCampaignPostContactSMSEvent.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingCampaignPostContactSmsEventTopicSMSAttributes.md b/build/docs/OutboundMessagingCampaignPostContactSmsEventTopicSMSAttributes.md index 2b866a888..8c8fd4969 100644 --- a/build/docs/OutboundMessagingCampaignPostContactSmsEventTopicSMSAttributes.md +++ b/build/docs/OutboundMessagingCampaignPostContactSmsEventTopicSMSAttributes.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingCampaignPreContactEmailEventTopicEmailAttributes.md b/build/docs/OutboundMessagingCampaignPreContactEmailEventTopicEmailAttributes.md index 3c3f15304..d8c743775 100644 --- a/build/docs/OutboundMessagingCampaignPreContactEmailEventTopicEmailAttributes.md +++ b/build/docs/OutboundMessagingCampaignPreContactEmailEventTopicEmailAttributes.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingCampaignPreContactEmailEventTopicOutboundMessagingCampaignPreContactEmailEvent.md b/build/docs/OutboundMessagingCampaignPreContactEmailEventTopicOutboundMessagingCampaignPreContactEmailEvent.md index ee8113322..af8f55cd2 100644 --- a/build/docs/OutboundMessagingCampaignPreContactEmailEventTopicOutboundMessagingCampaignPreContactEmailEvent.md +++ b/build/docs/OutboundMessagingCampaignPreContactEmailEventTopicOutboundMessagingCampaignPreContactEmailEvent.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingCampaignPreContactSmsEventTopicOutboundMessagingCampaignPreContactSMSEvent.md b/build/docs/OutboundMessagingCampaignPreContactSmsEventTopicOutboundMessagingCampaignPreContactSMSEvent.md index d89c70884..af7bd103b 100644 --- a/build/docs/OutboundMessagingCampaignPreContactSmsEventTopicOutboundMessagingCampaignPreContactSMSEvent.md +++ b/build/docs/OutboundMessagingCampaignPreContactSmsEventTopicOutboundMessagingCampaignPreContactSMSEvent.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingCampaignPreContactSmsEventTopicSMSAttributes.md b/build/docs/OutboundMessagingCampaignPreContactSmsEventTopicSMSAttributes.md index c021464b4..744231b79 100644 --- a/build/docs/OutboundMessagingCampaignPreContactSmsEventTopicSMSAttributes.md +++ b/build/docs/OutboundMessagingCampaignPreContactSmsEventTopicSMSAttributes.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeContactSort.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeContactSort.md index 08c74fdbf..6e42afe54 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeContactSort.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeContactSort.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeEmailConfig.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeEmailConfig.md index c5d878fec..9f02079e4 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeEmailConfig.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeEmailConfig.md @@ -14,4 +14,4 @@ An outbound-messaging messaging campaign email Config -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeErrorDetail.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeErrorDetail.md index cd71cebda..7093f3904 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeErrorDetail.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeErrorDetail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeFromEmailAddress.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeFromEmailAddress.md index c72008f21..9594960e1 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeFromEmailAddress.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeFromEmailAddress.md @@ -13,4 +13,4 @@ An outbound-messaging messaging campaign email address -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeMessagingCampaign.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeMessagingCampaign.md index 646cd724a..43ad1907f 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeMessagingCampaign.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeMessagingCampaign.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeObject.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeObject.md index b052e02d7..bf15a511d 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeObject.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeReplyToEmailAddress.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeReplyToEmailAddress.md index 5244fb10b..8d71158a9 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeReplyToEmailAddress.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeReplyToEmailAddress.md @@ -12,4 +12,4 @@ An outbound-messaging messaging campaign email address -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeResponseRef.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeResponseRef.md index 0b4b3ae18..570ba1bee 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeResponseRef.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeResponseRef.md @@ -11,4 +11,4 @@ A reference for a Response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeSmsConfig.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeSmsConfig.md index 697aaa5d1..99db9efe6 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeSmsConfig.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeSmsConfig.md @@ -14,4 +14,4 @@ An outbound-messaging messaging campaign SMS Config -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeSmsPhoneNumberRef.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeSmsPhoneNumberRef.md index 9fdf6a172..ff5703612 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeSmsPhoneNumberRef.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeSmsPhoneNumberRef.md @@ -11,4 +11,4 @@ A reference for an SmsPhoneNumber -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignConfigChangeUriReference.md b/build/docs/OutboundMessagingEmailCampaignConfigChangeUriReference.md index 4816e9bc8..c0c7f9428 100644 --- a/build/docs/OutboundMessagingEmailCampaignConfigChangeUriReference.md +++ b/build/docs/OutboundMessagingEmailCampaignConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignProgressEventCampaignProgress.md b/build/docs/OutboundMessagingEmailCampaignProgressEventCampaignProgress.md index 47ee2fcb3..881d1ced4 100644 --- a/build/docs/OutboundMessagingEmailCampaignProgressEventCampaignProgress.md +++ b/build/docs/OutboundMessagingEmailCampaignProgressEventCampaignProgress.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignProgressEventObject.md b/build/docs/OutboundMessagingEmailCampaignProgressEventObject.md index f9df0cdc1..cbc5af7d9 100644 --- a/build/docs/OutboundMessagingEmailCampaignProgressEventObject.md +++ b/build/docs/OutboundMessagingEmailCampaignProgressEventObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingEmailCampaignProgressEventUriReference.md b/build/docs/OutboundMessagingEmailCampaignProgressEventUriReference.md index 11d937ab4..58c1adc79 100644 --- a/build/docs/OutboundMessagingEmailCampaignProgressEventUriReference.md +++ b/build/docs/OutboundMessagingEmailCampaignProgressEventUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeContactSort.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeContactSort.md index fb9ea04b6..7e97fda06 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeContactSort.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeContactSort.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeEmailConfig.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeEmailConfig.md index 90e11ddbc..10ca8f7d7 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeEmailConfig.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeEmailConfig.md @@ -14,4 +14,4 @@ An outbound-messaging messaging campaign email Config -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeErrorDetail.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeErrorDetail.md index b3fb93f3c..77dd35866 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeErrorDetail.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeErrorDetail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeFromEmailAddress.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeFromEmailAddress.md index bc5f072c9..226809e6e 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeFromEmailAddress.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeFromEmailAddress.md @@ -13,4 +13,4 @@ An outbound-messaging messaging campaign email address -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeMessagingCampaign.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeMessagingCampaign.md index 9d70e8427..fdffe5a8f 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeMessagingCampaign.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeMessagingCampaign.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeObject.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeObject.md index db1c4f580..8dee23079 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeObject.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeReplyToEmailAddress.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeReplyToEmailAddress.md index 791a03525..fc5032974 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeReplyToEmailAddress.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeReplyToEmailAddress.md @@ -12,4 +12,4 @@ An outbound-messaging messaging campaign email address -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeResponseRef.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeResponseRef.md index 248fd1e18..d207d49a5 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeResponseRef.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeResponseRef.md @@ -11,4 +11,4 @@ A reference for a Response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeSmsConfig.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeSmsConfig.md index 88a645c5e..78a561334 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeSmsConfig.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeSmsConfig.md @@ -14,4 +14,4 @@ An outbound-messaging messaging campaign SMS Config -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef.md index 7cf618896..f979b5426 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef.md @@ -11,4 +11,4 @@ A reference for an SmsPhoneNumber -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignConfigChangeUriReference.md b/build/docs/OutboundMessagingMessagingCampaignConfigChangeUriReference.md index 8f87f9b59..f46351e07 100644 --- a/build/docs/OutboundMessagingMessagingCampaignConfigChangeUriReference.md +++ b/build/docs/OutboundMessagingMessagingCampaignConfigChangeUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignProgressEventCampaignProgress.md b/build/docs/OutboundMessagingMessagingCampaignProgressEventCampaignProgress.md index b6ba90b92..000307f0d 100644 --- a/build/docs/OutboundMessagingMessagingCampaignProgressEventCampaignProgress.md +++ b/build/docs/OutboundMessagingMessagingCampaignProgressEventCampaignProgress.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignProgressEventObject.md b/build/docs/OutboundMessagingMessagingCampaignProgressEventObject.md index ef0bc06df..15ca47e42 100644 --- a/build/docs/OutboundMessagingMessagingCampaignProgressEventObject.md +++ b/build/docs/OutboundMessagingMessagingCampaignProgressEventObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundMessagingMessagingCampaignProgressEventUriReference.md b/build/docs/OutboundMessagingMessagingCampaignProgressEventUriReference.md index 1fcec97f3..3b27e1fe8 100644 --- a/build/docs/OutboundMessagingMessagingCampaignProgressEventUriReference.md +++ b/build/docs/OutboundMessagingMessagingCampaignProgressEventUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundRoute.md b/build/docs/OutboundRoute.md index 8a10dcf03..6c5889073 100644 --- a/build/docs/OutboundRoute.md +++ b/build/docs/OutboundRoute.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundRouteBase.md b/build/docs/OutboundRouteBase.md index 2d4ca2fa6..2b9e2b381 100644 --- a/build/docs/OutboundRouteBase.md +++ b/build/docs/OutboundRouteBase.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundRouteBaseEntityListing.md b/build/docs/OutboundRouteBaseEntityListing.md index 2f17cdfe9..eb4e4d1e6 100644 --- a/build/docs/OutboundRouteBaseEntityListing.md +++ b/build/docs/OutboundRouteBaseEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundRouteEntityListing.md b/build/docs/OutboundRouteEntityListing.md index 3bd937b94..90a5d0f07 100644 --- a/build/docs/OutboundRouteEntityListing.md +++ b/build/docs/OutboundRouteEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutboundSettings.md b/build/docs/OutboundSettings.md index 4fd82899c..d17dfe1bb 100644 --- a/build/docs/OutboundSettings.md +++ b/build/docs/OutboundSettings.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Outcome.md b/build/docs/Outcome.md index b12ed4603..bb041f149 100644 --- a/build/docs/Outcome.md +++ b/build/docs/Outcome.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeAchievedEvent.md b/build/docs/OutcomeAchievedEvent.md index 0fced49e0..23be27b40 100644 --- a/build/docs/OutcomeAchievedEvent.md +++ b/build/docs/OutcomeAchievedEvent.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeAchievedEventOutcome.md b/build/docs/OutcomeAchievedEventOutcome.md index c4d28fd8e..ea877cdd4 100644 --- a/build/docs/OutcomeAchievedEventOutcome.md +++ b/build/docs/OutcomeAchievedEventOutcome.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeAchievement.md b/build/docs/OutcomeAchievement.md index 40a2ad946..59de25a2f 100644 --- a/build/docs/OutcomeAchievement.md +++ b/build/docs/OutcomeAchievement.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeConfig.md b/build/docs/OutcomeConfig.md index 8d19a1842..fb10e9e0c 100644 --- a/build/docs/OutcomeConfig.md +++ b/build/docs/OutcomeConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeListing.md b/build/docs/OutcomeListing.md index 9f9534514..7ed863234 100644 --- a/build/docs/OutcomeListing.md +++ b/build/docs/OutcomeListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomePercentileCondition.md b/build/docs/OutcomePercentileCondition.md index a9bf5316f..0ce0f5eb4 100644 --- a/build/docs/OutcomePercentileCondition.md +++ b/build/docs/OutcomePercentileCondition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomePredictor.md b/build/docs/OutcomePredictor.md index a8f5b5973..f2ea198fb 100644 --- a/build/docs/OutcomePredictor.md +++ b/build/docs/OutcomePredictor.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomePredictorListing.md b/build/docs/OutcomePredictorListing.md index 14a884ef4..53ca5d2d2 100644 --- a/build/docs/OutcomePredictorListing.md +++ b/build/docs/OutcomePredictorListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomePredictorRequest.md b/build/docs/OutcomePredictorRequest.md index 7bba1f1f5..035bf8b88 100644 --- a/build/docs/OutcomePredictorRequest.md +++ b/build/docs/OutcomePredictorRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeProbabilityCondition.md b/build/docs/OutcomeProbabilityCondition.md index 294da149a..4ec604bc9 100644 --- a/build/docs/OutcomeProbabilityCondition.md +++ b/build/docs/OutcomeProbabilityCondition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeQuantileCondition.md b/build/docs/OutcomeQuantileCondition.md index 163b842a6..ce3747256 100644 --- a/build/docs/OutcomeQuantileCondition.md +++ b/build/docs/OutcomeQuantileCondition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeRef.md b/build/docs/OutcomeRef.md index 491f5153d..9dc3d38e1 100644 --- a/build/docs/OutcomeRef.md +++ b/build/docs/OutcomeRef.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeRefRequest.md b/build/docs/OutcomeRefRequest.md index 8f458079e..160415224 100644 --- a/build/docs/OutcomeRefRequest.md +++ b/build/docs/OutcomeRefRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeRequest.md b/build/docs/OutcomeRequest.md index 70b4d374d..148c3e0a3 100644 --- a/build/docs/OutcomeRequest.md +++ b/build/docs/OutcomeRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeScore.md b/build/docs/OutcomeScore.md index 7bd746da9..75fd6d1a0 100644 --- a/build/docs/OutcomeScore.md +++ b/build/docs/OutcomeScore.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutcomeScoresResult.md b/build/docs/OutcomeScoresResult.md index f584e4479..e950a749f 100644 --- a/build/docs/OutcomeScoresResult.md +++ b/build/docs/OutcomeScoresResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OutlierInfo.md b/build/docs/OutlierInfo.md index ced26f72e..aeee749ac 100644 --- a/build/docs/OutlierInfo.md +++ b/build/docs/OutlierInfo.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OverallBestPoints.md b/build/docs/OverallBestPoints.md index 49f9b7986..8c23c18c2 100644 --- a/build/docs/OverallBestPoints.md +++ b/build/docs/OverallBestPoints.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/OverallBestPointsItem.md b/build/docs/OverallBestPointsItem.md index 335820ec9..7da3ed962 100644 --- a/build/docs/OverallBestPointsItem.md +++ b/build/docs/OverallBestPointsItem.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PINConfiguration.md b/build/docs/PINConfiguration.md index 1d9c49406..8eeb80aff 100644 --- a/build/docs/PINConfiguration.md +++ b/build/docs/PINConfiguration.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Page.md b/build/docs/Page.md index 1bdb04008..251ca2657 100644 --- a/build/docs/Page.md +++ b/build/docs/Page.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PagedNamespaceListing.md b/build/docs/PagedNamespaceListing.md index 14289b0b5..d163a1f77 100644 --- a/build/docs/PagedNamespaceListing.md +++ b/build/docs/PagedNamespaceListing.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PagedSkillCombinationListing.md b/build/docs/PagedSkillCombinationListing.md index cf666406a..4f170280e 100644 --- a/build/docs/PagedSkillCombinationListing.md +++ b/build/docs/PagedSkillCombinationListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PagelessDomainEntityListingEvaluationVersion.md b/build/docs/PagelessDomainEntityListingEvaluationVersion.md index 4549fc7fb..240f3c467 100644 --- a/build/docs/PagelessDomainEntityListingEvaluationVersion.md +++ b/build/docs/PagelessDomainEntityListingEvaluationVersion.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PagelessEntityListing.md b/build/docs/PagelessEntityListing.md index 43ccbf3b9..89af1e706 100644 --- a/build/docs/PagelessEntityListing.md +++ b/build/docs/PagelessEntityListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PagingSpec.md b/build/docs/PagingSpec.md index ff5f15809..013539319 100644 --- a/build/docs/PagingSpec.md +++ b/build/docs/PagingSpec.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ParkingStateRequest.md b/build/docs/ParkingStateRequest.md index 4b72fe647..bf3be6c95 100644 --- a/build/docs/ParkingStateRequest.md +++ b/build/docs/ParkingStateRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ParsedCertificate.md b/build/docs/ParsedCertificate.md index 891a46153..a011e530c 100644 --- a/build/docs/ParsedCertificate.md +++ b/build/docs/ParsedCertificate.md @@ -11,4 +11,4 @@ Represents the parsed certificate information. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Participant.md b/build/docs/Participant.md index acbaab594..1731a42f7 100644 --- a/build/docs/Participant.md +++ b/build/docs/Participant.md @@ -58,4 +58,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ParticipantAttributes.md b/build/docs/ParticipantAttributes.md index 4a89f51f1..cddff00ee 100644 --- a/build/docs/ParticipantAttributes.md +++ b/build/docs/ParticipantAttributes.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ParticipantBasic.md b/build/docs/ParticipantBasic.md index a30a3f097..f66573deb 100644 --- a/build/docs/ParticipantBasic.md +++ b/build/docs/ParticipantBasic.md @@ -58,4 +58,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ParticipantMetrics.md b/build/docs/ParticipantMetrics.md index 3be39859f..fd6d65a90 100644 --- a/build/docs/ParticipantMetrics.md +++ b/build/docs/ParticipantMetrics.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PasswordRequirements.md b/build/docs/PasswordRequirements.md index d5d3fa31c..4bb17de66 100644 --- a/build/docs/PasswordRequirements.md +++ b/build/docs/PasswordRequirements.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchAction.md b/build/docs/PatchAction.md index 42d5127c1..cb6402eca 100644 --- a/build/docs/PatchAction.md +++ b/build/docs/PatchAction.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchActionMap.md b/build/docs/PatchActionMap.md index 73565b85e..083814a79 100644 --- a/build/docs/PatchActionMap.md +++ b/build/docs/PatchActionMap.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchActionMapScheduleGroups.md b/build/docs/PatchActionMapScheduleGroups.md index af069d88c..8032ff8fe 100644 --- a/build/docs/PatchActionMapScheduleGroups.md +++ b/build/docs/PatchActionMapScheduleGroups.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchActionProperties.md b/build/docs/PatchActionProperties.md index 5688ca2f0..42ec0fc90 100644 --- a/build/docs/PatchActionProperties.md +++ b/build/docs/PatchActionProperties.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchActionSurvey.md b/build/docs/PatchActionSurvey.md index eff8c5595..0fdc37c86 100644 --- a/build/docs/PatchActionSurvey.md +++ b/build/docs/PatchActionSurvey.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchActionTarget.md b/build/docs/PatchActionTarget.md index ba3389ebc..525d00fbc 100644 --- a/build/docs/PatchActionTarget.md +++ b/build/docs/PatchActionTarget.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchActionTemplate.md b/build/docs/PatchActionTemplate.md index 9574b7988..297555fc1 100644 --- a/build/docs/PatchActionTemplate.md +++ b/build/docs/PatchActionTemplate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchAssociatedValueField.md b/build/docs/PatchAssociatedValueField.md index 42b72adad..5295593b1 100644 --- a/build/docs/PatchAssociatedValueField.md +++ b/build/docs/PatchAssociatedValueField.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchBuReschedulingOptionsManagementUnitRequest.md b/build/docs/PatchBuReschedulingOptionsManagementUnitRequest.md index cedeacf8b..3cbab3e0c 100644 --- a/build/docs/PatchBuReschedulingOptionsManagementUnitRequest.md +++ b/build/docs/PatchBuReschedulingOptionsManagementUnitRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchBuReschedulingOptionsRequest.md b/build/docs/PatchBuReschedulingOptionsRequest.md index 86d0d82d1..d84f4b998 100644 --- a/build/docs/PatchBuReschedulingOptionsRequest.md +++ b/build/docs/PatchBuReschedulingOptionsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchBuScheduleRunRequest.md b/build/docs/PatchBuScheduleRunRequest.md index 809cb2761..2f6cee359 100644 --- a/build/docs/PatchBuScheduleRunRequest.md +++ b/build/docs/PatchBuScheduleRunRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchCallToAction.md b/build/docs/PatchCallToAction.md index f2b34b69e..dd0bb5d37 100644 --- a/build/docs/PatchCallToAction.md +++ b/build/docs/PatchCallToAction.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchCallbackRequest.md b/build/docs/PatchCallbackRequest.md index ccf90a834..acd616528 100644 --- a/build/docs/PatchCallbackRequest.md +++ b/build/docs/PatchCallbackRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchCallbackResponse.md b/build/docs/PatchCallbackResponse.md index 66b2ac445..895af9620 100644 --- a/build/docs/PatchCallbackResponse.md +++ b/build/docs/PatchCallbackResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchCloseButtonStyleProperties.md b/build/docs/PatchCloseButtonStyleProperties.md index 35606d487..469373bfb 100644 --- a/build/docs/PatchCloseButtonStyleProperties.md +++ b/build/docs/PatchCloseButtonStyleProperties.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchContentOffer.md b/build/docs/PatchContentOffer.md index 98c303c45..260fbccf2 100644 --- a/build/docs/PatchContentOffer.md +++ b/build/docs/PatchContentOffer.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchContentOfferStyleProperties.md b/build/docs/PatchContentOfferStyleProperties.md index e1cf6c04d..9ae187e3f 100644 --- a/build/docs/PatchContentOfferStyleProperties.md +++ b/build/docs/PatchContentOfferStyleProperties.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchContentOfferStylingConfiguration.md b/build/docs/PatchContentOfferStylingConfiguration.md index f2ae1619e..ff6e5c18d 100644 --- a/build/docs/PatchContentOfferStylingConfiguration.md +++ b/build/docs/PatchContentOfferStylingConfiguration.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchContentPositionProperties.md b/build/docs/PatchContentPositionProperties.md index db635eccb..4d0708ab9 100644 --- a/build/docs/PatchContentPositionProperties.md +++ b/build/docs/PatchContentPositionProperties.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchContext.md b/build/docs/PatchContext.md index 86bc6adca..133d5a650 100644 --- a/build/docs/PatchContext.md +++ b/build/docs/PatchContext.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchContextPattern.md b/build/docs/PatchContextPattern.md index bb4de195c..b3359e21c 100644 --- a/build/docs/PatchContextPattern.md +++ b/build/docs/PatchContextPattern.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchCriteria.md b/build/docs/PatchCriteria.md index bb3e2b511..d3d5f0b9a 100644 --- a/build/docs/PatchCriteria.md +++ b/build/docs/PatchCriteria.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchCtaButtonStyleProperties.md b/build/docs/PatchCtaButtonStyleProperties.md index 1deb36cf8..21cda3ea6 100644 --- a/build/docs/PatchCtaButtonStyleProperties.md +++ b/build/docs/PatchCtaButtonStyleProperties.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchEntityTypeCriteria.md b/build/docs/PatchEntityTypeCriteria.md index 728d6d772..da68f8715 100644 --- a/build/docs/PatchEntityTypeCriteria.md +++ b/build/docs/PatchEntityTypeCriteria.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchExternalSegment.md b/build/docs/PatchExternalSegment.md index 5af42048d..ca4198118 100644 --- a/build/docs/PatchExternalSegment.md +++ b/build/docs/PatchExternalSegment.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchIntegrationAction.md b/build/docs/PatchIntegrationAction.md index 874691961..b5acd6e20 100644 --- a/build/docs/PatchIntegrationAction.md +++ b/build/docs/PatchIntegrationAction.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchIntegrationActionFields.md b/build/docs/PatchIntegrationActionFields.md index 46ce81763..bcf40b0cd 100644 --- a/build/docs/PatchIntegrationActionFields.md +++ b/build/docs/PatchIntegrationActionFields.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchJourney.md b/build/docs/PatchJourney.md index 3bfcbe76a..331338ffa 100644 --- a/build/docs/PatchJourney.md +++ b/build/docs/PatchJourney.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchJourneyPattern.md b/build/docs/PatchJourneyPattern.md index 24c72d1a8..c3ec445d3 100644 --- a/build/docs/PatchJourneyPattern.md +++ b/build/docs/PatchJourneyPattern.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchOutcome.md b/build/docs/PatchOutcome.md index a53e45911..94d60ded6 100644 --- a/build/docs/PatchOutcome.md +++ b/build/docs/PatchOutcome.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchPredictorRequest.md b/build/docs/PatchPredictorRequest.md index 1ba28d01d..85e9871f2 100644 --- a/build/docs/PatchPredictorRequest.md +++ b/build/docs/PatchPredictorRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchSegment.md b/build/docs/PatchSegment.md index 97c9f01c3..0dcce8027 100644 --- a/build/docs/PatchSegment.md +++ b/build/docs/PatchSegment.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchShiftTradeRequest.md b/build/docs/PatchShiftTradeRequest.md index 3eae4d518..890f4810c 100644 --- a/build/docs/PatchShiftTradeRequest.md +++ b/build/docs/PatchShiftTradeRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchSurveyQuestion.md b/build/docs/PatchSurveyQuestion.md index 970e4cdd8..37a7fc72b 100644 --- a/build/docs/PatchSurveyQuestion.md +++ b/build/docs/PatchSurveyQuestion.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchTextStyleProperties.md b/build/docs/PatchTextStyleProperties.md index e64275d0f..b8dc66b40 100644 --- a/build/docs/PatchTextStyleProperties.md +++ b/build/docs/PatchTextStyleProperties.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchUser.md b/build/docs/PatchUser.md index bdab91bae..092bf72c6 100644 --- a/build/docs/PatchUser.md +++ b/build/docs/PatchUser.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PatchWebMessagingOfferFields.md b/build/docs/PatchWebMessagingOfferFields.md index 938d01aba..75fb1d693 100644 --- a/build/docs/PatchWebMessagingOfferFields.md +++ b/build/docs/PatchWebMessagingOfferFields.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Pattern.md b/build/docs/Pattern.md index 41d409cdd..6a875ba23 100644 --- a/build/docs/Pattern.md +++ b/build/docs/Pattern.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PauseCriteria.md b/build/docs/PauseCriteria.md index 4318b4778..b2aa3b602 100644 --- a/build/docs/PauseCriteria.md +++ b/build/docs/PauseCriteria.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionCompleteEventTopicErrorBody.md b/build/docs/PerformancePredictionCompleteEventTopicErrorBody.md index dbf7c554e..b7209c9cb 100644 --- a/build/docs/PerformancePredictionCompleteEventTopicErrorBody.md +++ b/build/docs/PerformancePredictionCompleteEventTopicErrorBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionCompleteEventTopicPerformancePredictionCalculationNotification.md b/build/docs/PerformancePredictionCompleteEventTopicPerformancePredictionCalculationNotification.md index 4eb22435d..65a16475d 100644 --- a/build/docs/PerformancePredictionCompleteEventTopicPerformancePredictionCalculationNotification.md +++ b/build/docs/PerformancePredictionCompleteEventTopicPerformancePredictionCalculationNotification.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionOutputs.md b/build/docs/PerformancePredictionOutputs.md index fd8863fdf..50b7b7c54 100644 --- a/build/docs/PerformancePredictionOutputs.md +++ b/build/docs/PerformancePredictionOutputs.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionRecalculationCompleteEventTopicErrorBody.md b/build/docs/PerformancePredictionRecalculationCompleteEventTopicErrorBody.md index 0704d115f..43e183bcc 100644 --- a/build/docs/PerformancePredictionRecalculationCompleteEventTopicErrorBody.md +++ b/build/docs/PerformancePredictionRecalculationCompleteEventTopicErrorBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionRecalculationCompleteEventTopicPerformancePredictionUserRecalculationNotification.md b/build/docs/PerformancePredictionRecalculationCompleteEventTopicPerformancePredictionUserRecalculationNotification.md index f57326b7e..b1fb84b6c 100644 --- a/build/docs/PerformancePredictionRecalculationCompleteEventTopicPerformancePredictionUserRecalculationNotification.md +++ b/build/docs/PerformancePredictionRecalculationCompleteEventTopicPerformancePredictionUserRecalculationNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionRecalculationResponse.md b/build/docs/PerformancePredictionRecalculationResponse.md index 521ca2f49..10ebc052d 100644 --- a/build/docs/PerformancePredictionRecalculationResponse.md +++ b/build/docs/PerformancePredictionRecalculationResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionRecalculationUploadResponse.md b/build/docs/PerformancePredictionRecalculationUploadResponse.md index 675816080..57f5eca20 100644 --- a/build/docs/PerformancePredictionRecalculationUploadResponse.md +++ b/build/docs/PerformancePredictionRecalculationUploadResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionResponse.md b/build/docs/PerformancePredictionResponse.md index 9f0ae5bc0..4b3f201fc 100644 --- a/build/docs/PerformancePredictionResponse.md +++ b/build/docs/PerformancePredictionResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformancePredictionUploadSchema.md b/build/docs/PerformancePredictionUploadSchema.md index d9bddb415..01d1e6131 100644 --- a/build/docs/PerformancePredictionUploadSchema.md +++ b/build/docs/PerformancePredictionUploadSchema.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PerformanceProfile.md b/build/docs/PerformanceProfile.md index 2eabd4583..38ba3200a 100644 --- a/build/docs/PerformanceProfile.md +++ b/build/docs/PerformanceProfile.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PermissionCollectionEntityListing.md b/build/docs/PermissionCollectionEntityListing.md index 4279c4272..8ce0726f1 100644 --- a/build/docs/PermissionCollectionEntityListing.md +++ b/build/docs/PermissionCollectionEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PermissionDetails.md b/build/docs/PermissionDetails.md index 616068066..e1e9b22a4 100644 --- a/build/docs/PermissionDetails.md +++ b/build/docs/PermissionDetails.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Permissions.md b/build/docs/Permissions.md index 41e3e4dc3..bd39cb352 100644 --- a/build/docs/Permissions.md +++ b/build/docs/Permissions.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PersistentConnectionChangeTopicErrorInfo.md b/build/docs/PersistentConnectionChangeTopicErrorInfo.md new file mode 100644 index 000000000..c367d0206 --- /dev/null +++ b/build/docs/PersistentConnectionChangeTopicErrorInfo.md @@ -0,0 +1,17 @@ +# PersistentConnectionChangeTopicErrorInfo + +## PersistentConnectionChangeTopicErrorInfo + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **text** | **String** | | [optional] | +| **code** | **String** | | [optional] | +| **userMessage** | **String** | | [optional] | +| **userParams** | **[String:String]** | | [optional] | +| **nestedErrorDetails** | [**[PersistentConnectionChangeTopicErrorInfoDetails]**](PersistentConnectionChangeTopicErrorInfoDetails) | | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PersistentConnectionChangeTopicErrorInfoDetails.md b/build/docs/PersistentConnectionChangeTopicErrorInfoDetails.md new file mode 100644 index 000000000..8b52bdfc8 --- /dev/null +++ b/build/docs/PersistentConnectionChangeTopicErrorInfoDetails.md @@ -0,0 +1,17 @@ +# PersistentConnectionChangeTopicErrorInfoDetails + +## PersistentConnectionChangeTopicErrorInfoDetails + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **code** | **String** | | [optional] | +| **userMessage** | **String** | | [optional] | +| **userParams** | **[String:String]** | | [optional] | +| **hostname** | **String** | | [optional] | +| **location** | [**PersistentConnectionChangeTopicErrorLocation**](PersistentConnectionChangeTopicErrorLocation) | | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PersistentConnectionChangeTopicErrorLocation.md b/build/docs/PersistentConnectionChangeTopicErrorLocation.md new file mode 100644 index 000000000..fb0bad398 --- /dev/null +++ b/build/docs/PersistentConnectionChangeTopicErrorLocation.md @@ -0,0 +1,15 @@ +# PersistentConnectionChangeTopicErrorLocation + +## PersistentConnectionChangeTopicErrorLocation + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **function** | **String** | | [optional] | +| **fileID** | **String** | | [optional] | +| **line** | **Int** | | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PersistentConnectionChangeTopicPersistentConnectionChangeEvent.md b/build/docs/PersistentConnectionChangeTopicPersistentConnectionChangeEvent.md new file mode 100644 index 000000000..eb58a2eb3 --- /dev/null +++ b/build/docs/PersistentConnectionChangeTopicPersistentConnectionChangeEvent.md @@ -0,0 +1,17 @@ +# PersistentConnectionChangeTopicPersistentConnectionChangeEvent + +## PersistentConnectionChangeTopicPersistentConnectionChangeEvent + +## Properties + +|Name | Type | Description | Notes| +|------------ | ------------- | ------------- | -------------| +| **errorInfo** | [**PersistentConnectionChangeTopicErrorInfo**](PersistentConnectionChangeTopicErrorInfo) | | [optional] | +| **stationId** | **String** | | [optional] | +| **userId** | **String** | | [optional] | +| **persistentState** | **String** | | [optional] | +| **eventTime** | [**Date**](Date) | | [optional] | + + + +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Phone.md b/build/docs/Phone.md index 8d85aa004..5feb9b1ad 100644 --- a/build/docs/Phone.md +++ b/build/docs/Phone.md @@ -35,4 +35,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneBase.md b/build/docs/PhoneBase.md index 8a37fa840..00641f075 100644 --- a/build/docs/PhoneBase.md +++ b/build/docs/PhoneBase.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneBaseEntityListing.md b/build/docs/PhoneBaseEntityListing.md index 082f435cd..ac7950041 100644 --- a/build/docs/PhoneBaseEntityListing.md +++ b/build/docs/PhoneBaseEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneBaseSettings.md b/build/docs/PhoneBaseSettings.md index 7a43889d1..c146d5310 100644 --- a/build/docs/PhoneBaseSettings.md +++ b/build/docs/PhoneBaseSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneCapabilities.md b/build/docs/PhoneCapabilities.md index f0d55dc05..91df2ac5c 100644 --- a/build/docs/PhoneCapabilities.md +++ b/build/docs/PhoneCapabilities.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneChangeTopicEdgeReference.md b/build/docs/PhoneChangeTopicEdgeReference.md index 6b8771228..c1cdc4216 100644 --- a/build/docs/PhoneChangeTopicEdgeReference.md +++ b/build/docs/PhoneChangeTopicEdgeReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneChangeTopicLineStatus.md b/build/docs/PhoneChangeTopicLineStatus.md index e8f289e5d..ac2ffc56d 100644 --- a/build/docs/PhoneChangeTopicLineStatus.md +++ b/build/docs/PhoneChangeTopicLineStatus.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneChangeTopicPhone.md b/build/docs/PhoneChangeTopicPhone.md index b54f7bde1..e1cec6ace 100644 --- a/build/docs/PhoneChangeTopicPhone.md +++ b/build/docs/PhoneChangeTopicPhone.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneChangeTopicPhoneStatus.md b/build/docs/PhoneChangeTopicPhoneStatus.md index c3971fedc..318cb842c 100644 --- a/build/docs/PhoneChangeTopicPhoneStatus.md +++ b/build/docs/PhoneChangeTopicPhoneStatus.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneChangeTopicProvisionInfo.md b/build/docs/PhoneChangeTopicProvisionInfo.md index bf33abf34..be7e03919 100644 --- a/build/docs/PhoneChangeTopicProvisionInfo.md +++ b/build/docs/PhoneChangeTopicProvisionInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneChangeTopicUserAgentInfo.md b/build/docs/PhoneChangeTopicUserAgentInfo.md index 1e1b14908..d65cec19b 100644 --- a/build/docs/PhoneChangeTopicUserAgentInfo.md +++ b/build/docs/PhoneChangeTopicUserAgentInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneColumn.md b/build/docs/PhoneColumn.md index e156903c3..bdb21403a 100644 --- a/build/docs/PhoneColumn.md +++ b/build/docs/PhoneColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneEntityListing.md b/build/docs/PhoneEntityListing.md index 2b4efab71..c4339f318 100644 --- a/build/docs/PhoneEntityListing.md +++ b/build/docs/PhoneEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneEstablishedEvent.md b/build/docs/PhoneEstablishedEvent.md index 6d06915aa..8f5515f50 100644 --- a/build/docs/PhoneEstablishedEvent.md +++ b/build/docs/PhoneEstablishedEvent.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneMetaBaseEntityListing.md b/build/docs/PhoneMetaBaseEntityListing.md index 72ed16f11..4bfa5c329 100644 --- a/build/docs/PhoneMetaBaseEntityListing.md +++ b/build/docs/PhoneMetaBaseEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneNumber.md b/build/docs/PhoneNumber.md index 893c89827..6c0a5661d 100644 --- a/build/docs/PhoneNumber.md +++ b/build/docs/PhoneNumber.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneNumberColumn.md b/build/docs/PhoneNumberColumn.md index afb1ce4ad..8214edde4 100644 --- a/build/docs/PhoneNumberColumn.md +++ b/build/docs/PhoneNumberColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneNumberStatus.md b/build/docs/PhoneNumberStatus.md index 970df01ec..356d2efd8 100644 --- a/build/docs/PhoneNumberStatus.md +++ b/build/docs/PhoneNumberStatus.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneStatus.md b/build/docs/PhoneStatus.md index 33f943f15..414081d71 100644 --- a/build/docs/PhoneStatus.md +++ b/build/docs/PhoneStatus.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhoneTransferEvent.md b/build/docs/PhoneTransferEvent.md index 09e750a13..bd890a471 100644 --- a/build/docs/PhoneTransferEvent.md +++ b/build/docs/PhoneTransferEvent.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhonesReboot.md b/build/docs/PhonesReboot.md index 9b74ccbc8..11b3b4b6b 100644 --- a/build/docs/PhonesReboot.md +++ b/build/docs/PhonesReboot.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Phrase.md b/build/docs/Phrase.md index e43ed6dde..9a9ab9a4c 100644 --- a/build/docs/Phrase.md +++ b/build/docs/Phrase.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhraseAssociations.md b/build/docs/PhraseAssociations.md index aec5add9b..bb8edc88b 100644 --- a/build/docs/PhraseAssociations.md +++ b/build/docs/PhraseAssociations.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PhysicalInterfaceEntityListing.md b/build/docs/PhysicalInterfaceEntityListing.md index aa401d4a2..598da2a27 100644 --- a/build/docs/PhysicalInterfaceEntityListing.md +++ b/build/docs/PhysicalInterfaceEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PingIdentity.md b/build/docs/PingIdentity.md index bb36edf31..78378d60e 100644 --- a/build/docs/PingIdentity.md +++ b/build/docs/PingIdentity.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PinnedMessageRequest.md b/build/docs/PinnedMessageRequest.md index 5c6afe8c1..e3b2a8bc2 100644 --- a/build/docs/PinnedMessageRequest.md +++ b/build/docs/PinnedMessageRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PlanningGroup.md b/build/docs/PlanningGroup.md index fce48f421..64fff2506 100644 --- a/build/docs/PlanningGroup.md +++ b/build/docs/PlanningGroup.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PlanningGroupList.md b/build/docs/PlanningGroupList.md index 02ddca649..cfcd78c5c 100644 --- a/build/docs/PlanningGroupList.md +++ b/build/docs/PlanningGroupList.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PlanningGroupOutputs.md b/build/docs/PlanningGroupOutputs.md index b82916fd2..d5494540e 100644 --- a/build/docs/PlanningGroupOutputs.md +++ b/build/docs/PlanningGroupOutputs.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PlanningGroupReference.md b/build/docs/PlanningGroupReference.md index 094bd45cd..647c2e162 100644 --- a/build/docs/PlanningGroupReference.md +++ b/build/docs/PlanningGroupReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PlanningPeriodSettings.md b/build/docs/PlanningPeriodSettings.md index e3d69e750..f34926cee 100644 --- a/build/docs/PlanningPeriodSettings.md +++ b/build/docs/PlanningPeriodSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Policy.md b/build/docs/Policy.md index f31400734..419ec53ae 100644 --- a/build/docs/Policy.md +++ b/build/docs/Policy.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PolicyActions.md b/build/docs/PolicyActions.md index e9718cefb..d46b98710 100644 --- a/build/docs/PolicyActions.md +++ b/build/docs/PolicyActions.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PolicyConditions.md b/build/docs/PolicyConditions.md index 784af0a51..8e4f4a570 100644 --- a/build/docs/PolicyConditions.md +++ b/build/docs/PolicyConditions.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PolicyCreate.md b/build/docs/PolicyCreate.md index d6ae93d1a..cb5d0a1b5 100644 --- a/build/docs/PolicyCreate.md +++ b/build/docs/PolicyCreate.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PolicyEntityListing.md b/build/docs/PolicyEntityListing.md index 0816f0cb4..607497dd2 100644 --- a/build/docs/PolicyEntityListing.md +++ b/build/docs/PolicyEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PolicyErrorMessage.md b/build/docs/PolicyErrorMessage.md index 6cf1b693f..e5010e978 100644 --- a/build/docs/PolicyErrorMessage.md +++ b/build/docs/PolicyErrorMessage.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PolicyErrors.md b/build/docs/PolicyErrors.md index 8def4bb38..14553effc 100644 --- a/build/docs/PolicyErrors.md +++ b/build/docs/PolicyErrors.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PolicyUpdate.md b/build/docs/PolicyUpdate.md index 27a52e8bc..5d8350859 100644 --- a/build/docs/PolicyUpdate.md +++ b/build/docs/PolicyUpdate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PositionSettings.md b/build/docs/PositionSettings.md index fa1a5f902..97b1bd9cd 100644 --- a/build/docs/PositionSettings.md +++ b/build/docs/PositionSettings.md @@ -13,4 +13,4 @@ Settings concerning position -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PossibleWorkShiftsForWeek.md b/build/docs/PossibleWorkShiftsForWeek.md index c2a4701db..337c3b433 100644 --- a/build/docs/PossibleWorkShiftsForWeek.md +++ b/build/docs/PossibleWorkShiftsForWeek.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PostActionInput.md b/build/docs/PostActionInput.md index b79b90a3d..a7fbf3654 100644 --- a/build/docs/PostActionInput.md +++ b/build/docs/PostActionInput.md @@ -16,4 +16,4 @@ Definition of an Action to be created or updated. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PostInputContract.md b/build/docs/PostInputContract.md index 417e45801..bb015f0d4 100644 --- a/build/docs/PostInputContract.md +++ b/build/docs/PostInputContract.md @@ -11,4 +11,4 @@ The schemas defining all of the expected requests/inputs. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PostOutputContract.md b/build/docs/PostOutputContract.md index 0261600e7..4a282ded2 100644 --- a/build/docs/PostOutputContract.md +++ b/build/docs/PostOutputContract.md @@ -11,4 +11,4 @@ The schemas defining all of the expected responses/outputs. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PostTextMessage.md b/build/docs/PostTextMessage.md index e33e604a1..88f97094c 100644 --- a/build/docs/PostTextMessage.md +++ b/build/docs/PostTextMessage.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PostTextRequest.md b/build/docs/PostTextRequest.md index a1f4319b8..20ea76822 100644 --- a/build/docs/PostTextRequest.md +++ b/build/docs/PostTextRequest.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PostTextResponse.md b/build/docs/PostTextResponse.md index 93e88992c..064c4e43b 100644 --- a/build/docs/PostTextResponse.md +++ b/build/docs/PostTextResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictionResults.md b/build/docs/PredictionResults.md index f6eaab808..94cc86cd8 100644 --- a/build/docs/PredictionResults.md +++ b/build/docs/PredictionResults.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictiveRouting.md b/build/docs/PredictiveRouting.md index cb337512e..eb78181c0 100644 --- a/build/docs/PredictiveRouting.md +++ b/build/docs/PredictiveRouting.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Predictor.md b/build/docs/Predictor.md index 71502434d..3df59c4f4 100644 --- a/build/docs/Predictor.md +++ b/build/docs/Predictor.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorListing.md b/build/docs/PredictorListing.md index f3ef0ceca..74811b6bb 100644 --- a/build/docs/PredictorListing.md +++ b/build/docs/PredictorListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorModel.md b/build/docs/PredictorModel.md index 4b88c2014..1ed996d2b 100644 --- a/build/docs/PredictorModel.md +++ b/build/docs/PredictorModel.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorModelBrief.md b/build/docs/PredictorModelBrief.md index eb898eaec..13211a174 100644 --- a/build/docs/PredictorModelBrief.md +++ b/build/docs/PredictorModelBrief.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorModelFeature.md b/build/docs/PredictorModelFeature.md index 68e543b17..28604c998 100644 --- a/build/docs/PredictorModelFeature.md +++ b/build/docs/PredictorModelFeature.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorModelFeatureListing.md b/build/docs/PredictorModelFeatureListing.md index 15e928d71..f530bb6d6 100644 --- a/build/docs/PredictorModelFeatureListing.md +++ b/build/docs/PredictorModelFeatureListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorModelRetrainingError.md b/build/docs/PredictorModelRetrainingError.md index 9a6dd5e15..ffe1f5dce 100644 --- a/build/docs/PredictorModelRetrainingError.md +++ b/build/docs/PredictorModelRetrainingError.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorModels.md b/build/docs/PredictorModels.md index 2088fb15e..610e1609d 100644 --- a/build/docs/PredictorModels.md +++ b/build/docs/PredictorModels.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorSchedule.md b/build/docs/PredictorSchedule.md index 5629fb76c..2363a62b0 100644 --- a/build/docs/PredictorSchedule.md +++ b/build/docs/PredictorSchedule.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PredictorWorkloadBalancing.md b/build/docs/PredictorWorkloadBalancing.md index a9d6d5be9..08f644b91 100644 --- a/build/docs/PredictorWorkloadBalancing.md +++ b/build/docs/PredictorWorkloadBalancing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PreprocessingRule.md b/build/docs/PreprocessingRule.md index d7609c69f..e68df4819 100644 --- a/build/docs/PreprocessingRule.md +++ b/build/docs/PreprocessingRule.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PresenceAPI.md b/build/docs/PresenceAPI.md index 2955d7984..3be199c90 100644 --- a/build/docs/PresenceAPI.md +++ b/build/docs/PresenceAPI.md @@ -1407,4 +1407,4 @@ PresenceAPI.putUsersPresencesBulk(body: body) { (response, error) in [**[UserPresence]**](UserPresence) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PresenceDefinition.md b/build/docs/PresenceDefinition.md index 299750d25..e1fa85068 100644 --- a/build/docs/PresenceDefinition.md +++ b/build/docs/PresenceDefinition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PresenceDetailQueryClause.md b/build/docs/PresenceDetailQueryClause.md index ddbe468d9..0f14e5c23 100644 --- a/build/docs/PresenceDetailQueryClause.md +++ b/build/docs/PresenceDetailQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PresenceDetailQueryFilter.md b/build/docs/PresenceDetailQueryFilter.md index b804dfcfd..fbd34aed6 100644 --- a/build/docs/PresenceDetailQueryFilter.md +++ b/build/docs/PresenceDetailQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PresenceDetailQueryPredicate.md b/build/docs/PresenceDetailQueryPredicate.md index d9dbe0fe2..67e3098b3 100644 --- a/build/docs/PresenceDetailQueryPredicate.md +++ b/build/docs/PresenceDetailQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PresenceEventOrganizationPresence.md b/build/docs/PresenceEventOrganizationPresence.md index 1e870a961..69f42caf0 100644 --- a/build/docs/PresenceEventOrganizationPresence.md +++ b/build/docs/PresenceEventOrganizationPresence.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PresenceEventUserPresence.md b/build/docs/PresenceEventUserPresence.md index 9a2ae69ff..1411994f4 100644 --- a/build/docs/PresenceEventUserPresence.md +++ b/build/docs/PresenceEventUserPresence.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PresenceSettings.md b/build/docs/PresenceSettings.md index 3baaa48f7..735d8b43f 100644 --- a/build/docs/PresenceSettings.md +++ b/build/docs/PresenceSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProcessAutomationAPI.md b/build/docs/ProcessAutomationAPI.md index a10d814a8..e5076b23c 100644 --- a/build/docs/ProcessAutomationAPI.md +++ b/build/docs/ProcessAutomationAPI.md @@ -437,4 +437,4 @@ ProcessAutomationAPI.putProcessautomationTrigger(triggerId: triggerId, body: bod [**Trigger**](Trigger) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProcessScheduleUpdateUploadRequest.md b/build/docs/ProcessScheduleUpdateUploadRequest.md index 2517ac279..24a032d30 100644 --- a/build/docs/ProcessScheduleUpdateUploadRequest.md +++ b/build/docs/ProcessScheduleUpdateUploadRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProfileWithDateRange.md b/build/docs/ProfileWithDateRange.md index 26be045b1..a2eaa2b75 100644 --- a/build/docs/ProfileWithDateRange.md +++ b/build/docs/ProfileWithDateRange.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Program.md b/build/docs/Program.md index 29936060f..77ee807f2 100644 --- a/build/docs/Program.md +++ b/build/docs/Program.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramJob.md b/build/docs/ProgramJob.md index 1fc357dbc..bf8ae9486 100644 --- a/build/docs/ProgramJob.md +++ b/build/docs/ProgramJob.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramJobRequest.md b/build/docs/ProgramJobRequest.md index 54be9dd27..a6bfc8e4e 100644 --- a/build/docs/ProgramJobRequest.md +++ b/build/docs/ProgramJobRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramMappings.md b/build/docs/ProgramMappings.md index 445fbed77..06c2f954a 100644 --- a/build/docs/ProgramMappings.md +++ b/build/docs/ProgramMappings.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramMappingsRequest.md b/build/docs/ProgramMappingsRequest.md index 2cab60d56..71fe276a9 100644 --- a/build/docs/ProgramMappingsRequest.md +++ b/build/docs/ProgramMappingsRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramRequest.md b/build/docs/ProgramRequest.md index 908c2593b..f70371b7b 100644 --- a/build/docs/ProgramRequest.md +++ b/build/docs/ProgramRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramTopicLinksTopicsDefinitionsJob.md b/build/docs/ProgramTopicLinksTopicsDefinitionsJob.md index f3578d21d..a974aeefe 100644 --- a/build/docs/ProgramTopicLinksTopicsDefinitionsJob.md +++ b/build/docs/ProgramTopicLinksTopicsDefinitionsJob.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramTranscriptionEngine.md b/build/docs/ProgramTranscriptionEngine.md index 5de19517d..1968d88a6 100644 --- a/build/docs/ProgramTranscriptionEngine.md +++ b/build/docs/ProgramTranscriptionEngine.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramTranscriptionEngines.md b/build/docs/ProgramTranscriptionEngines.md index c25f1887f..1dde0380d 100644 --- a/build/docs/ProgramTranscriptionEngines.md +++ b/build/docs/ProgramTranscriptionEngines.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramsEntityListing.md b/build/docs/ProgramsEntityListing.md index 56aad225d..31f649e12 100644 --- a/build/docs/ProgramsEntityListing.md +++ b/build/docs/ProgramsEntityListing.md @@ -8,10 +8,10 @@ |------------ | ------------- | ------------- | -------------| | **entities** | [**[ListedProgram]**](ListedProgram) | | [optional] | | **pageSize** | **Int** | | [optional] | -| **nextUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgramsMappingsEntityListing.md b/build/docs/ProgramsMappingsEntityListing.md index 7e04d62d9..f55fff992 100644 --- a/build/docs/ProgramsMappingsEntityListing.md +++ b/build/docs/ProgramsMappingsEntityListing.md @@ -8,10 +8,10 @@ |------------ | ------------- | ------------- | -------------| | **entities** | [**[ProgramMappings]**](ProgramMappings) | | [optional] | | **pageSize** | **Int** | | [optional] | -| **nextUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | +| **nextUri** | **String** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgressConsultTransferEvent.md b/build/docs/ProgressConsultTransferEvent.md index 9ab01a903..898700056 100644 --- a/build/docs/ProgressConsultTransferEvent.md +++ b/build/docs/ProgressConsultTransferEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProgressTransferEvent.md b/build/docs/ProgressTransferEvent.md index 8accd8420..a7b32ff9b 100644 --- a/build/docs/ProgressTransferEvent.md +++ b/build/docs/ProgressTransferEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Prompt.md b/build/docs/Prompt.md index 6320c7415..5927e0055 100644 --- a/build/docs/Prompt.md +++ b/build/docs/Prompt.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PromptAsset.md b/build/docs/PromptAsset.md index 28821180e..b6cb78007 100644 --- a/build/docs/PromptAsset.md +++ b/build/docs/PromptAsset.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PromptAssetCreate.md b/build/docs/PromptAssetCreate.md index 7e3757221..c215a4f35 100644 --- a/build/docs/PromptAssetCreate.md +++ b/build/docs/PromptAssetCreate.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PromptAssetEntityListing.md b/build/docs/PromptAssetEntityListing.md index a0b2c1723..76853a871 100644 --- a/build/docs/PromptAssetEntityListing.md +++ b/build/docs/PromptAssetEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PromptEntityListing.md b/build/docs/PromptEntityListing.md index 5cf98e4b3..b0a762b96 100644 --- a/build/docs/PromptEntityListing.md +++ b/build/docs/PromptEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PropertyChange.md b/build/docs/PropertyChange.md index 0e134b83c..f11fc33fd 100644 --- a/build/docs/PropertyChange.md +++ b/build/docs/PropertyChange.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PropertyIndexRequest.md b/build/docs/PropertyIndexRequest.md index 14f4e10e4..4295e57fa 100644 --- a/build/docs/PropertyIndexRequest.md +++ b/build/docs/PropertyIndexRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ProvisionInfo.md b/build/docs/ProvisionInfo.md index 7bcae7fac..c9f5e08f6 100644 --- a/build/docs/ProvisionInfo.md +++ b/build/docs/ProvisionInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PublishDraftInput.md b/build/docs/PublishDraftInput.md index 60ba9129f..28bdd265b 100644 --- a/build/docs/PublishDraftInput.md +++ b/build/docs/PublishDraftInput.md @@ -11,4 +11,4 @@ Draft to be published -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PublishForm.md b/build/docs/PublishForm.md index 9b2f81182..cedaa0666 100644 --- a/build/docs/PublishForm.md +++ b/build/docs/PublishForm.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PublishProgramTopicsDefinitionsJob.md b/build/docs/PublishProgramTopicsDefinitionsJob.md index ab24ad99d..12c3bb963 100644 --- a/build/docs/PublishProgramTopicsDefinitionsJob.md +++ b/build/docs/PublishProgramTopicsDefinitionsJob.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PublishScriptRequestData.md b/build/docs/PublishScriptRequestData.md index d85903f98..2cce115ce 100644 --- a/build/docs/PublishScriptRequestData.md +++ b/build/docs/PublishScriptRequestData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PublishTopicTopicsDefinitionsJob.md b/build/docs/PublishTopicTopicsDefinitionsJob.md index 5c609c566..91f48e164 100644 --- a/build/docs/PublishTopicTopicsDefinitionsJob.md +++ b/build/docs/PublishTopicTopicsDefinitionsJob.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PublishedSurveyFormReference.md b/build/docs/PublishedSurveyFormReference.md index ebe31726d..123e2a066 100644 --- a/build/docs/PublishedSurveyFormReference.md +++ b/build/docs/PublishedSurveyFormReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PunctualityEvent.md b/build/docs/PunctualityEvent.md index 4d738f578..629a811ac 100644 --- a/build/docs/PunctualityEvent.md +++ b/build/docs/PunctualityEvent.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PureCloud.md b/build/docs/PureCloud.md index 7462bde13..0edd348a0 100644 --- a/build/docs/PureCloud.md +++ b/build/docs/PureCloud.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/PureEngage.md b/build/docs/PureEngage.md index 0444eb999..52618db6e 100644 --- a/build/docs/PureEngage.md +++ b/build/docs/PureEngage.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QMAuditQueryRequest.md b/build/docs/QMAuditQueryRequest.md index db72a8708..3cbc18841 100644 --- a/build/docs/QMAuditQueryRequest.md +++ b/build/docs/QMAuditQueryRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QualityAPI.md b/build/docs/QualityAPI.md index 27f968778..2c70ef3d9 100644 --- a/build/docs/QualityAPI.md +++ b/build/docs/QualityAPI.md @@ -3044,4 +3044,4 @@ QualityAPI.putQualitySurveysScorable(customerSurveyUrl: customerSurveyUrl, body: [**ScorableSurvey**](ScorableSurvey) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QualityAuditLogMessage.md b/build/docs/QualityAuditLogMessage.md index 9464952a7..ecfb4a2dd 100644 --- a/build/docs/QualityAuditLogMessage.md +++ b/build/docs/QualityAuditLogMessage.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QualityAuditQueryExecutionResultsResponse.md b/build/docs/QualityAuditQueryExecutionResultsResponse.md index c555130e8..e982de3c5 100644 --- a/build/docs/QualityAuditQueryExecutionResultsResponse.md +++ b/build/docs/QualityAuditQueryExecutionResultsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QualityAuditQueryExecutionStatusResponse.md b/build/docs/QualityAuditQueryExecutionStatusResponse.md index fff2d84f7..1e407154a 100644 --- a/build/docs/QualityAuditQueryExecutionStatusResponse.md +++ b/build/docs/QualityAuditQueryExecutionStatusResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QualityAuditQueryFilter.md b/build/docs/QualityAuditQueryFilter.md index 48d06a408..224d9f150 100644 --- a/build/docs/QualityAuditQueryFilter.md +++ b/build/docs/QualityAuditQueryFilter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QualityEvaluationScoreItem.md b/build/docs/QualityEvaluationScoreItem.md index 396cc75ac..16b82bb2f 100644 --- a/build/docs/QualityEvaluationScoreItem.md +++ b/build/docs/QualityEvaluationScoreItem.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryAdherenceExplanationsResponse.md b/build/docs/QueryAdherenceExplanationsResponse.md index e263cffbc..0782199b8 100644 --- a/build/docs/QueryAdherenceExplanationsResponse.md +++ b/build/docs/QueryAdherenceExplanationsResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryAgentsIntegrationsRequest.md b/build/docs/QueryAgentsIntegrationsRequest.md index fa83d3178..5008b1cda 100644 --- a/build/docs/QueryAgentsIntegrationsRequest.md +++ b/build/docs/QueryAgentsIntegrationsRequest.md @@ -11,4 +11,4 @@ Query integrations for agents request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryCriteria.md b/build/docs/QueryCriteria.md index 5a7dbadfa..847a1913b 100644 --- a/build/docs/QueryCriteria.md +++ b/build/docs/QueryCriteria.md @@ -16,4 +16,4 @@ A criteria type that can be used in tandem with other criteria type to create qu -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryDivision.md b/build/docs/QueryDivision.md index 294111fdf..5b3b9bfe0 100644 --- a/build/docs/QueryDivision.md +++ b/build/docs/QueryDivision.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryFacetInfo.md b/build/docs/QueryFacetInfo.md index 59b5d36bd..eca984aa8 100644 --- a/build/docs/QueryFacetInfo.md +++ b/build/docs/QueryFacetInfo.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryRequest.md b/build/docs/QueryRequest.md index 552a3e6ff..942b7a81c 100644 --- a/build/docs/QueryRequest.md +++ b/build/docs/QueryRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryRequestClause.md b/build/docs/QueryRequestClause.md index f4d1c5087..2f5d5d495 100644 --- a/build/docs/QueryRequestClause.md +++ b/build/docs/QueryRequestClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryRequestFilter.md b/build/docs/QueryRequestFilter.md index 900febc4e..169f5fd92 100644 --- a/build/docs/QueryRequestFilter.md +++ b/build/docs/QueryRequestFilter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryRequestPredicate.md b/build/docs/QueryRequestPredicate.md index 58d1d219a..9255bd4be 100644 --- a/build/docs/QueryRequestPredicate.md +++ b/build/docs/QueryRequestPredicate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryResponseData.md b/build/docs/QueryResponseData.md index 4086bc628..e4411e729 100644 --- a/build/docs/QueryResponseData.md +++ b/build/docs/QueryResponseData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryResponseGroupedData.md b/build/docs/QueryResponseGroupedData.md index c84017dce..ad1880d11 100644 --- a/build/docs/QueryResponseGroupedData.md +++ b/build/docs/QueryResponseGroupedData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryResponseMetric.md b/build/docs/QueryResponseMetric.md index 7ef84cbfe..7232497bd 100644 --- a/build/docs/QueryResponseMetric.md +++ b/build/docs/QueryResponseMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryResponseStats.md b/build/docs/QueryResponseStats.md index 2f578b0ca..0fd87a210 100644 --- a/build/docs/QueryResponseStats.md +++ b/build/docs/QueryResponseStats.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryResult.md b/build/docs/QueryResult.md index c2aef4ee0..d2dd8f997 100644 --- a/build/docs/QueryResult.md +++ b/build/docs/QueryResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryResults.md b/build/docs/QueryResults.md index acf3ee94f..c5b7ffb2d 100644 --- a/build/docs/QueryResults.md +++ b/build/docs/QueryResults.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryTimeOffIntegrationStatusRequest.md b/build/docs/QueryTimeOffIntegrationStatusRequest.md index 4c84ee401..6855ba8c9 100644 --- a/build/docs/QueryTimeOffIntegrationStatusRequest.md +++ b/build/docs/QueryTimeOffIntegrationStatusRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryTimeOffLimitValuesRequest.md b/build/docs/QueryTimeOffLimitValuesRequest.md index 25563d402..51188cb71 100644 --- a/build/docs/QueryTimeOffLimitValuesRequest.md +++ b/build/docs/QueryTimeOffLimitValuesRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryTimeOffLimitValuesResponse.md b/build/docs/QueryTimeOffLimitValuesResponse.md index 7e9cb8157..b5a35728d 100644 --- a/build/docs/QueryTimeOffLimitValuesResponse.md +++ b/build/docs/QueryTimeOffLimitValuesResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryUserStaffingGroupListRequest.md b/build/docs/QueryUserStaffingGroupListRequest.md index b627bad85..703935b6e 100644 --- a/build/docs/QueryUserStaffingGroupListRequest.md +++ b/build/docs/QueryUserStaffingGroupListRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueryWaitlistPositionsRequest.md b/build/docs/QueryWaitlistPositionsRequest.md index 28a194fbd..002deb5d6 100644 --- a/build/docs/QueryWaitlistPositionsRequest.md +++ b/build/docs/QueryWaitlistPositionsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QuestionGroupSettings.md b/build/docs/QuestionGroupSettings.md index 5267af4c4..89732a9af 100644 --- a/build/docs/QuestionGroupSettings.md +++ b/build/docs/QuestionGroupSettings.md @@ -6,10 +6,9 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -| **questionGroupIndex** | **Int** | This field represents the location of the Question Group in the form. Note: Indexes are zero-based | [optional] | | **questionGroupContextId** | **String** | The context id of the question group in the form. | [optional] | | **questionSettings** | [**[QuestionSettings]**](QuestionSettings) | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QuestionSettings.md b/build/docs/QuestionSettings.md index 7b2889c42..55d49faba 100644 --- a/build/docs/QuestionSettings.md +++ b/build/docs/QuestionSettings.md @@ -6,10 +6,9 @@ |Name | Type | Description | Notes| |------------ | ------------- | ------------- | -------------| -| **questionIndex** | **Int** | This field represents the location of the Question in the form. Note: Indexes are zero-based | [optional] | | **questionContextId** | **String** | The context id of the question in the group | [optional] | | **settings** | [**AiScoringSetting**](AiScoringSetting) | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Queue.md b/build/docs/Queue.md index 991f6c31e..60c0a4d60 100644 --- a/build/docs/Queue.md +++ b/build/docs/Queue.md @@ -48,4 +48,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicCallConversation.md b/build/docs/QueueConversationCallEventTopicCallConversation.md index 792b40227..0dc829097 100644 --- a/build/docs/QueueConversationCallEventTopicCallConversation.md +++ b/build/docs/QueueConversationCallEventTopicCallConversation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicCallMediaParticipant.md b/build/docs/QueueConversationCallEventTopicCallMediaParticipant.md index 77862d182..75e33c07a 100644 --- a/build/docs/QueueConversationCallEventTopicCallMediaParticipant.md +++ b/build/docs/QueueConversationCallEventTopicCallMediaParticipant.md @@ -64,4 +64,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationCallEventTopicConversationDivisionMembership.md index 9e60dc572..d808526ae 100644 --- a/build/docs/QueueConversationCallEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationCallEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicConversationRoutingData.md b/build/docs/QueueConversationCallEventTopicConversationRoutingData.md index 9ea36741a..e19a6f670 100644 --- a/build/docs/QueueConversationCallEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationCallEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicDetail.md b/build/docs/QueueConversationCallEventTopicDetail.md index ef701f0d6..d678e89fc 100644 --- a/build/docs/QueueConversationCallEventTopicDetail.md +++ b/build/docs/QueueConversationCallEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicDivisionEntityRef.md b/build/docs/QueueConversationCallEventTopicDivisionEntityRef.md index 20631b29e..b410108f3 100644 --- a/build/docs/QueueConversationCallEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationCallEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicDomainEntityRef.md b/build/docs/QueueConversationCallEventTopicDomainEntityRef.md index a8f651e18..b3e57391f 100644 --- a/build/docs/QueueConversationCallEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationCallEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicErrorBody.md b/build/docs/QueueConversationCallEventTopicErrorBody.md index 2f1934e85..de18fad28 100644 --- a/build/docs/QueueConversationCallEventTopicErrorBody.md +++ b/build/docs/QueueConversationCallEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicFaxStatus.md b/build/docs/QueueConversationCallEventTopicFaxStatus.md index c9b7190bf..1ce84e8fe 100644 --- a/build/docs/QueueConversationCallEventTopicFaxStatus.md +++ b/build/docs/QueueConversationCallEventTopicFaxStatus.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicJourneyAction.md b/build/docs/QueueConversationCallEventTopicJourneyAction.md index dcdfa6077..d9b810c0c 100644 --- a/build/docs/QueueConversationCallEventTopicJourneyAction.md +++ b/build/docs/QueueConversationCallEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicJourneyActionMap.md b/build/docs/QueueConversationCallEventTopicJourneyActionMap.md index 3f44fe05b..d447551a2 100644 --- a/build/docs/QueueConversationCallEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationCallEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicJourneyContext.md b/build/docs/QueueConversationCallEventTopicJourneyContext.md index 2d5503860..91d5b9902 100644 --- a/build/docs/QueueConversationCallEventTopicJourneyContext.md +++ b/build/docs/QueueConversationCallEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicJourneyCustomer.md b/build/docs/QueueConversationCallEventTopicJourneyCustomer.md index bb1feeb5c..0b115effd 100644 --- a/build/docs/QueueConversationCallEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationCallEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationCallEventTopicJourneyCustomerSession.md index 090288c5c..a14b37cee 100644 --- a/build/docs/QueueConversationCallEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationCallEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicLimit.md b/build/docs/QueueConversationCallEventTopicLimit.md index 1b8e651c7..37688ee19 100644 --- a/build/docs/QueueConversationCallEventTopicLimit.md +++ b/build/docs/QueueConversationCallEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicQueueMediaSettings.md b/build/docs/QueueConversationCallEventTopicQueueMediaSettings.md index 2388547d4..a2ff0ee8d 100644 --- a/build/docs/QueueConversationCallEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationCallEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicScoredAgent.md b/build/docs/QueueConversationCallEventTopicScoredAgent.md index 344025d37..d716be88f 100644 --- a/build/docs/QueueConversationCallEventTopicScoredAgent.md +++ b/build/docs/QueueConversationCallEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicUriReference.md b/build/docs/QueueConversationCallEventTopicUriReference.md index d9d2b0191..5b501ef3a 100644 --- a/build/docs/QueueConversationCallEventTopicUriReference.md +++ b/build/docs/QueueConversationCallEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallEventTopicWrapup.md b/build/docs/QueueConversationCallEventTopicWrapup.md index ace31420d..1cc2f3636 100644 --- a/build/docs/QueueConversationCallEventTopicWrapup.md +++ b/build/docs/QueueConversationCallEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicCallbackConversation.md b/build/docs/QueueConversationCallbackEventTopicCallbackConversation.md index 9e23801f4..e4c4fff9a 100644 --- a/build/docs/QueueConversationCallbackEventTopicCallbackConversation.md +++ b/build/docs/QueueConversationCallbackEventTopicCallbackConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md b/build/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md index 63d64eb0b..24a08bb23 100644 --- a/build/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md +++ b/build/docs/QueueConversationCallbackEventTopicCallbackMediaParticipant.md @@ -58,4 +58,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationCallbackEventTopicConversationDivisionMembership.md index 907a69655..86c247d19 100644 --- a/build/docs/QueueConversationCallbackEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationCallbackEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicConversationRoutingData.md b/build/docs/QueueConversationCallbackEventTopicConversationRoutingData.md index b229dc9fd..a0acc5d93 100644 --- a/build/docs/QueueConversationCallbackEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationCallbackEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicDetail.md b/build/docs/QueueConversationCallbackEventTopicDetail.md index d25b11598..d21961068 100644 --- a/build/docs/QueueConversationCallbackEventTopicDetail.md +++ b/build/docs/QueueConversationCallbackEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicDialerPreview.md b/build/docs/QueueConversationCallbackEventTopicDialerPreview.md index 76c13f08d..40bcbe2e3 100644 --- a/build/docs/QueueConversationCallbackEventTopicDialerPreview.md +++ b/build/docs/QueueConversationCallbackEventTopicDialerPreview.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicDivisionEntityRef.md b/build/docs/QueueConversationCallbackEventTopicDivisionEntityRef.md index b82e860a1..78748f9cb 100644 --- a/build/docs/QueueConversationCallbackEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationCallbackEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicDomainEntityRef.md b/build/docs/QueueConversationCallbackEventTopicDomainEntityRef.md index 6c1e8423f..eb4c21268 100644 --- a/build/docs/QueueConversationCallbackEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationCallbackEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicErrorBody.md b/build/docs/QueueConversationCallbackEventTopicErrorBody.md index f9525dcb0..2d517e6c8 100644 --- a/build/docs/QueueConversationCallbackEventTopicErrorBody.md +++ b/build/docs/QueueConversationCallbackEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicJourneyAction.md b/build/docs/QueueConversationCallbackEventTopicJourneyAction.md index 54bd69f5e..ec99c3f2e 100644 --- a/build/docs/QueueConversationCallbackEventTopicJourneyAction.md +++ b/build/docs/QueueConversationCallbackEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicJourneyActionMap.md b/build/docs/QueueConversationCallbackEventTopicJourneyActionMap.md index 427bc3474..0931a48de 100644 --- a/build/docs/QueueConversationCallbackEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationCallbackEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicJourneyContext.md b/build/docs/QueueConversationCallbackEventTopicJourneyContext.md index 93a58389d..2488f88c9 100644 --- a/build/docs/QueueConversationCallbackEventTopicJourneyContext.md +++ b/build/docs/QueueConversationCallbackEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicJourneyCustomer.md b/build/docs/QueueConversationCallbackEventTopicJourneyCustomer.md index 0dd37bd63..8f7d43f36 100644 --- a/build/docs/QueueConversationCallbackEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationCallbackEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationCallbackEventTopicJourneyCustomerSession.md index 0e7da6d86..f5207d77e 100644 --- a/build/docs/QueueConversationCallbackEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationCallbackEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicLimit.md b/build/docs/QueueConversationCallbackEventTopicLimit.md index ff3a6451b..c6f4ace3b 100644 --- a/build/docs/QueueConversationCallbackEventTopicLimit.md +++ b/build/docs/QueueConversationCallbackEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicPhoneNumberColumn.md b/build/docs/QueueConversationCallbackEventTopicPhoneNumberColumn.md index fb23e0a08..6abf94d3c 100644 --- a/build/docs/QueueConversationCallbackEventTopicPhoneNumberColumn.md +++ b/build/docs/QueueConversationCallbackEventTopicPhoneNumberColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicQueueMediaSettings.md b/build/docs/QueueConversationCallbackEventTopicQueueMediaSettings.md index 00b327e1c..57a861188 100644 --- a/build/docs/QueueConversationCallbackEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationCallbackEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicScoredAgent.md b/build/docs/QueueConversationCallbackEventTopicScoredAgent.md index a4e8c9854..3d842eac7 100644 --- a/build/docs/QueueConversationCallbackEventTopicScoredAgent.md +++ b/build/docs/QueueConversationCallbackEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicUriReference.md b/build/docs/QueueConversationCallbackEventTopicUriReference.md index 9d69548a7..9f40896c2 100644 --- a/build/docs/QueueConversationCallbackEventTopicUriReference.md +++ b/build/docs/QueueConversationCallbackEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicVoicemail.md b/build/docs/QueueConversationCallbackEventTopicVoicemail.md index 70c451e24..574d93f27 100644 --- a/build/docs/QueueConversationCallbackEventTopicVoicemail.md +++ b/build/docs/QueueConversationCallbackEventTopicVoicemail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCallbackEventTopicWrapup.md b/build/docs/QueueConversationCallbackEventTopicWrapup.md index 666883dae..dcaa96221 100644 --- a/build/docs/QueueConversationCallbackEventTopicWrapup.md +++ b/build/docs/QueueConversationCallbackEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicChatConversation.md b/build/docs/QueueConversationChatEventTopicChatConversation.md index a8565935a..2f2b66e43 100644 --- a/build/docs/QueueConversationChatEventTopicChatConversation.md +++ b/build/docs/QueueConversationChatEventTopicChatConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicChatMediaParticipant.md b/build/docs/QueueConversationChatEventTopicChatMediaParticipant.md index 7043371cc..c95820023 100644 --- a/build/docs/QueueConversationChatEventTopicChatMediaParticipant.md +++ b/build/docs/QueueConversationChatEventTopicChatMediaParticipant.md @@ -51,4 +51,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationChatEventTopicConversationDivisionMembership.md index 97ee43a60..85807c408 100644 --- a/build/docs/QueueConversationChatEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationChatEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicConversationRoutingData.md b/build/docs/QueueConversationChatEventTopicConversationRoutingData.md index 5d5c3207e..3b07c038e 100644 --- a/build/docs/QueueConversationChatEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationChatEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicDetail.md b/build/docs/QueueConversationChatEventTopicDetail.md index 8a4d7bfb0..22d475f77 100644 --- a/build/docs/QueueConversationChatEventTopicDetail.md +++ b/build/docs/QueueConversationChatEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicDivisionEntityRef.md b/build/docs/QueueConversationChatEventTopicDivisionEntityRef.md index 659dfacaa..b3ad4c735 100644 --- a/build/docs/QueueConversationChatEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationChatEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicDomainEntityRef.md b/build/docs/QueueConversationChatEventTopicDomainEntityRef.md index 394b33eb9..75fc3ee68 100644 --- a/build/docs/QueueConversationChatEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationChatEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicErrorBody.md b/build/docs/QueueConversationChatEventTopicErrorBody.md index 9170a24bb..aa887b9be 100644 --- a/build/docs/QueueConversationChatEventTopicErrorBody.md +++ b/build/docs/QueueConversationChatEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicJourneyAction.md b/build/docs/QueueConversationChatEventTopicJourneyAction.md index e4ae6590d..df6281257 100644 --- a/build/docs/QueueConversationChatEventTopicJourneyAction.md +++ b/build/docs/QueueConversationChatEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicJourneyActionMap.md b/build/docs/QueueConversationChatEventTopicJourneyActionMap.md index 28a8d731f..f648614bf 100644 --- a/build/docs/QueueConversationChatEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationChatEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicJourneyContext.md b/build/docs/QueueConversationChatEventTopicJourneyContext.md index c098874ed..e662ad714 100644 --- a/build/docs/QueueConversationChatEventTopicJourneyContext.md +++ b/build/docs/QueueConversationChatEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicJourneyCustomer.md b/build/docs/QueueConversationChatEventTopicJourneyCustomer.md index 13d190c42..30214772a 100644 --- a/build/docs/QueueConversationChatEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationChatEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationChatEventTopicJourneyCustomerSession.md index b37f67204..b9c8f56c4 100644 --- a/build/docs/QueueConversationChatEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationChatEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicLimit.md b/build/docs/QueueConversationChatEventTopicLimit.md index 2bf1d73c7..20c95e28c 100644 --- a/build/docs/QueueConversationChatEventTopicLimit.md +++ b/build/docs/QueueConversationChatEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicQueueMediaSettings.md b/build/docs/QueueConversationChatEventTopicQueueMediaSettings.md index dd0b5d748..3f83b018c 100644 --- a/build/docs/QueueConversationChatEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationChatEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicScoredAgent.md b/build/docs/QueueConversationChatEventTopicScoredAgent.md index ed2ae796e..b4b70497c 100644 --- a/build/docs/QueueConversationChatEventTopicScoredAgent.md +++ b/build/docs/QueueConversationChatEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicUriReference.md b/build/docs/QueueConversationChatEventTopicUriReference.md index 64bbd792f..333501427 100644 --- a/build/docs/QueueConversationChatEventTopicUriReference.md +++ b/build/docs/QueueConversationChatEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationChatEventTopicWrapup.md b/build/docs/QueueConversationChatEventTopicWrapup.md index 7dc4a0e7b..fd4c7af65 100644 --- a/build/docs/QueueConversationChatEventTopicWrapup.md +++ b/build/docs/QueueConversationChatEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicCobrowseConversation.md b/build/docs/QueueConversationCobrowseEventTopicCobrowseConversation.md index 2acaa13ea..5126e1bb6 100644 --- a/build/docs/QueueConversationCobrowseEventTopicCobrowseConversation.md +++ b/build/docs/QueueConversationCobrowseEventTopicCobrowseConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md b/build/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md index eac1bf38a..518824fab 100644 --- a/build/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md +++ b/build/docs/QueueConversationCobrowseEventTopicCobrowseMediaParticipant.md @@ -54,4 +54,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationCobrowseEventTopicConversationDivisionMembership.md index d76af815a..be2873670 100644 --- a/build/docs/QueueConversationCobrowseEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationCobrowseEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicConversationRoutingData.md b/build/docs/QueueConversationCobrowseEventTopicConversationRoutingData.md index 3de4e5b70..c752ed6e5 100644 --- a/build/docs/QueueConversationCobrowseEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationCobrowseEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicDetail.md b/build/docs/QueueConversationCobrowseEventTopicDetail.md index b128da1bb..305675e1b 100644 --- a/build/docs/QueueConversationCobrowseEventTopicDetail.md +++ b/build/docs/QueueConversationCobrowseEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicDivisionEntityRef.md b/build/docs/QueueConversationCobrowseEventTopicDivisionEntityRef.md index b03240f80..0bb2606ad 100644 --- a/build/docs/QueueConversationCobrowseEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationCobrowseEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicDomainEntityRef.md b/build/docs/QueueConversationCobrowseEventTopicDomainEntityRef.md index 9b6e84ce3..09f14a095 100644 --- a/build/docs/QueueConversationCobrowseEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationCobrowseEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicErrorBody.md b/build/docs/QueueConversationCobrowseEventTopicErrorBody.md index 88ea2e0f6..f3abda61a 100644 --- a/build/docs/QueueConversationCobrowseEventTopicErrorBody.md +++ b/build/docs/QueueConversationCobrowseEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicJourneyAction.md b/build/docs/QueueConversationCobrowseEventTopicJourneyAction.md index e4d410fa6..a16024d8c 100644 --- a/build/docs/QueueConversationCobrowseEventTopicJourneyAction.md +++ b/build/docs/QueueConversationCobrowseEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicJourneyActionMap.md b/build/docs/QueueConversationCobrowseEventTopicJourneyActionMap.md index c997a6fe5..e83331bbd 100644 --- a/build/docs/QueueConversationCobrowseEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationCobrowseEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicJourneyContext.md b/build/docs/QueueConversationCobrowseEventTopicJourneyContext.md index 3f3fdb39c..61581d277 100644 --- a/build/docs/QueueConversationCobrowseEventTopicJourneyContext.md +++ b/build/docs/QueueConversationCobrowseEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicJourneyCustomer.md b/build/docs/QueueConversationCobrowseEventTopicJourneyCustomer.md index 9a9f181de..ddf018a7c 100644 --- a/build/docs/QueueConversationCobrowseEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationCobrowseEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationCobrowseEventTopicJourneyCustomerSession.md index 811a07957..f5b08b1c2 100644 --- a/build/docs/QueueConversationCobrowseEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationCobrowseEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicLimit.md b/build/docs/QueueConversationCobrowseEventTopicLimit.md index 6dedb1771..303c583e1 100644 --- a/build/docs/QueueConversationCobrowseEventTopicLimit.md +++ b/build/docs/QueueConversationCobrowseEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicQueueMediaSettings.md b/build/docs/QueueConversationCobrowseEventTopicQueueMediaSettings.md index 177d7e75d..d6f25e6c3 100644 --- a/build/docs/QueueConversationCobrowseEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationCobrowseEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicScoredAgent.md b/build/docs/QueueConversationCobrowseEventTopicScoredAgent.md index 3eeae394d..c8b59154f 100644 --- a/build/docs/QueueConversationCobrowseEventTopicScoredAgent.md +++ b/build/docs/QueueConversationCobrowseEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicUriReference.md b/build/docs/QueueConversationCobrowseEventTopicUriReference.md index c5a26cb86..02d26cf56 100644 --- a/build/docs/QueueConversationCobrowseEventTopicUriReference.md +++ b/build/docs/QueueConversationCobrowseEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationCobrowseEventTopicWrapup.md b/build/docs/QueueConversationCobrowseEventTopicWrapup.md index f0a8863dc..7b6e445eb 100644 --- a/build/docs/QueueConversationCobrowseEventTopicWrapup.md +++ b/build/docs/QueueConversationCobrowseEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicAttachment.md b/build/docs/QueueConversationEmailEventTopicAttachment.md index 52b3d34e1..9acd5e76d 100644 --- a/build/docs/QueueConversationEmailEventTopicAttachment.md +++ b/build/docs/QueueConversationEmailEventTopicAttachment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationEmailEventTopicConversationDivisionMembership.md index aa457515e..bb6db4cbc 100644 --- a/build/docs/QueueConversationEmailEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationEmailEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicConversationRoutingData.md b/build/docs/QueueConversationEmailEventTopicConversationRoutingData.md index ee95d2322..187e286e1 100644 --- a/build/docs/QueueConversationEmailEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationEmailEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicDetail.md b/build/docs/QueueConversationEmailEventTopicDetail.md index 6b9a46fe9..8a1de86cb 100644 --- a/build/docs/QueueConversationEmailEventTopicDetail.md +++ b/build/docs/QueueConversationEmailEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicDivisionEntityRef.md b/build/docs/QueueConversationEmailEventTopicDivisionEntityRef.md index 889492152..13c5f6dfc 100644 --- a/build/docs/QueueConversationEmailEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationEmailEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicDomainEntityRef.md b/build/docs/QueueConversationEmailEventTopicDomainEntityRef.md index 300ef73cc..03f4e3845 100644 --- a/build/docs/QueueConversationEmailEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationEmailEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicEmailConversation.md b/build/docs/QueueConversationEmailEventTopicEmailConversation.md index fb5821c73..e91ec5ee4 100644 --- a/build/docs/QueueConversationEmailEventTopicEmailConversation.md +++ b/build/docs/QueueConversationEmailEventTopicEmailConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md b/build/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md index 8d30a5342..72164df88 100644 --- a/build/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md +++ b/build/docs/QueueConversationEmailEventTopicEmailMediaParticipant.md @@ -55,4 +55,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicErrorBody.md b/build/docs/QueueConversationEmailEventTopicErrorBody.md index 52b0b9c5a..3ccf79651 100644 --- a/build/docs/QueueConversationEmailEventTopicErrorBody.md +++ b/build/docs/QueueConversationEmailEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicJourneyAction.md b/build/docs/QueueConversationEmailEventTopicJourneyAction.md index 4ed1c393d..75a2aa40a 100644 --- a/build/docs/QueueConversationEmailEventTopicJourneyAction.md +++ b/build/docs/QueueConversationEmailEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicJourneyActionMap.md b/build/docs/QueueConversationEmailEventTopicJourneyActionMap.md index fdd5359c2..b2e862510 100644 --- a/build/docs/QueueConversationEmailEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationEmailEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicJourneyContext.md b/build/docs/QueueConversationEmailEventTopicJourneyContext.md index 09bac59e9..2e463c834 100644 --- a/build/docs/QueueConversationEmailEventTopicJourneyContext.md +++ b/build/docs/QueueConversationEmailEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicJourneyCustomer.md b/build/docs/QueueConversationEmailEventTopicJourneyCustomer.md index 418751737..d9cdc2393 100644 --- a/build/docs/QueueConversationEmailEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationEmailEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationEmailEventTopicJourneyCustomerSession.md index fcd327334..d24c130a4 100644 --- a/build/docs/QueueConversationEmailEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationEmailEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicLimit.md b/build/docs/QueueConversationEmailEventTopicLimit.md index 5492fac35..3b65f7c1a 100644 --- a/build/docs/QueueConversationEmailEventTopicLimit.md +++ b/build/docs/QueueConversationEmailEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicQueueMediaSettings.md b/build/docs/QueueConversationEmailEventTopicQueueMediaSettings.md index b285b66e7..93d3926f9 100644 --- a/build/docs/QueueConversationEmailEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationEmailEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicScoredAgent.md b/build/docs/QueueConversationEmailEventTopicScoredAgent.md index 73433f574..2003e326f 100644 --- a/build/docs/QueueConversationEmailEventTopicScoredAgent.md +++ b/build/docs/QueueConversationEmailEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicUriReference.md b/build/docs/QueueConversationEmailEventTopicUriReference.md index d9682fbb9..8166f1e4d 100644 --- a/build/docs/QueueConversationEmailEventTopicUriReference.md +++ b/build/docs/QueueConversationEmailEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEmailEventTopicWrapup.md b/build/docs/QueueConversationEmailEventTopicWrapup.md index 878257803..967f5b1e3 100644 --- a/build/docs/QueueConversationEmailEventTopicWrapup.md +++ b/build/docs/QueueConversationEmailEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicAddress.md b/build/docs/QueueConversationEventTopicAddress.md index 69933d1e2..eadd5b3c4 100644 --- a/build/docs/QueueConversationEventTopicAddress.md +++ b/build/docs/QueueConversationEventTopicAddress.md @@ -15,4 +15,4 @@ Address and name data for a call endpoint. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicAfterCallWork.md b/build/docs/QueueConversationEventTopicAfterCallWork.md index 757b77f61..ffa175105 100644 --- a/build/docs/QueueConversationEventTopicAfterCallWork.md +++ b/build/docs/QueueConversationEventTopicAfterCallWork.md @@ -13,4 +13,4 @@ A communication's after-call work data. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicAttachment.md b/build/docs/QueueConversationEventTopicAttachment.md index 6963db657..fcee096ab 100644 --- a/build/docs/QueueConversationEventTopicAttachment.md +++ b/build/docs/QueueConversationEventTopicAttachment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicCall.md b/build/docs/QueueConversationEventTopicCall.md index 3d3a247bf..5ebd53171 100644 --- a/build/docs/QueueConversationEventTopicCall.md +++ b/build/docs/QueueConversationEventTopicCall.md @@ -39,4 +39,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicCallback.md b/build/docs/QueueConversationEventTopicCallback.md index 954d9e029..d7db32dd8 100644 --- a/build/docs/QueueConversationEventTopicCallback.md +++ b/build/docs/QueueConversationEventTopicCallback.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicChat.md b/build/docs/QueueConversationEventTopicChat.md index 272fd19a2..4ccd1d5ce 100644 --- a/build/docs/QueueConversationEventTopicChat.md +++ b/build/docs/QueueConversationEventTopicChat.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicCobrowse.md b/build/docs/QueueConversationEventTopicCobrowse.md index 17aacbdc1..9fa240269 100644 --- a/build/docs/QueueConversationEventTopicCobrowse.md +++ b/build/docs/QueueConversationEventTopicCobrowse.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicConversation.md b/build/docs/QueueConversationEventTopicConversation.md index a7ca33959..ca4f46fe6 100644 --- a/build/docs/QueueConversationEventTopicConversation.md +++ b/build/docs/QueueConversationEventTopicConversation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationEventTopicConversationDivisionMembership.md index 84d54e7c2..923846d65 100644 --- a/build/docs/QueueConversationEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicConversationRoutingData.md b/build/docs/QueueConversationEventTopicConversationRoutingData.md index 98606c911..57b805f99 100644 --- a/build/docs/QueueConversationEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationEventTopicConversationRoutingData.md @@ -15,4 +15,4 @@ Information on how a communication should be routed to an agent. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicDialerPreview.md b/build/docs/QueueConversationEventTopicDialerPreview.md index 75a2498e1..0fd673ccc 100644 --- a/build/docs/QueueConversationEventTopicDialerPreview.md +++ b/build/docs/QueueConversationEventTopicDialerPreview.md @@ -15,4 +15,4 @@ The preview data to be used when this callback is a Preview. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicDisconnectReason.md b/build/docs/QueueConversationEventTopicDisconnectReason.md index d0fcde787..97b6601d0 100644 --- a/build/docs/QueueConversationEventTopicDisconnectReason.md +++ b/build/docs/QueueConversationEventTopicDisconnectReason.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicDivisionEntityRef.md b/build/docs/QueueConversationEventTopicDivisionEntityRef.md index 4476d5779..dba2f29f6 100644 --- a/build/docs/QueueConversationEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicDomainEntityRef.md b/build/docs/QueueConversationEventTopicDomainEntityRef.md index 86f234913..1d0f9c4ab 100644 --- a/build/docs/QueueConversationEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicEmail.md b/build/docs/QueueConversationEventTopicEmail.md index 9669e6b03..45dbf0d19 100644 --- a/build/docs/QueueConversationEventTopicEmail.md +++ b/build/docs/QueueConversationEventTopicEmail.md @@ -34,4 +34,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicErrorDetails.md b/build/docs/QueueConversationEventTopicErrorDetails.md index 1bab0bc87..09101919d 100644 --- a/build/docs/QueueConversationEventTopicErrorDetails.md +++ b/build/docs/QueueConversationEventTopicErrorDetails.md @@ -17,4 +17,4 @@ Detailed information about an error response. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicFaxStatus.md b/build/docs/QueueConversationEventTopicFaxStatus.md index 9ec31778a..623530ca6 100644 --- a/build/docs/QueueConversationEventTopicFaxStatus.md +++ b/build/docs/QueueConversationEventTopicFaxStatus.md @@ -18,4 +18,4 @@ Extra information on fax transmission. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicInternalMessage.md b/build/docs/QueueConversationEventTopicInternalMessage.md index 48cca8431..138f4001f 100644 --- a/build/docs/QueueConversationEventTopicInternalMessage.md +++ b/build/docs/QueueConversationEventTopicInternalMessage.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicInternalMessageDetails.md b/build/docs/QueueConversationEventTopicInternalMessageDetails.md index 1934b601d..2ebb83b2e 100644 --- a/build/docs/QueueConversationEventTopicInternalMessageDetails.md +++ b/build/docs/QueueConversationEventTopicInternalMessageDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicJourneyAction.md b/build/docs/QueueConversationEventTopicJourneyAction.md index 99f473c84..dfd032912 100644 --- a/build/docs/QueueConversationEventTopicJourneyAction.md +++ b/build/docs/QueueConversationEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicJourneyActionMap.md b/build/docs/QueueConversationEventTopicJourneyActionMap.md index 781d2deb3..8b0679930 100644 --- a/build/docs/QueueConversationEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicJourneyContext.md b/build/docs/QueueConversationEventTopicJourneyContext.md index 8304dcbc8..b4fb1a8c8 100644 --- a/build/docs/QueueConversationEventTopicJourneyContext.md +++ b/build/docs/QueueConversationEventTopicJourneyContext.md @@ -13,4 +13,4 @@ A subset of the Journey System's data relevant to a part of a conversation ( -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicJourneyCustomer.md b/build/docs/QueueConversationEventTopicJourneyCustomer.md index 324388034..c8787d064 100644 --- a/build/docs/QueueConversationEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationEventTopicJourneyCustomerSession.md index e3b4e4f4d..f8f547bab 100644 --- a/build/docs/QueueConversationEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicMessage.md b/build/docs/QueueConversationEventTopicMessage.md index d65accc4c..261204240 100644 --- a/build/docs/QueueConversationEventTopicMessage.md +++ b/build/docs/QueueConversationEventTopicMessage.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicMessageDetails.md b/build/docs/QueueConversationEventTopicMessageDetails.md index 398aac408..53ef2a7c5 100644 --- a/build/docs/QueueConversationEventTopicMessageDetails.md +++ b/build/docs/QueueConversationEventTopicMessageDetails.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicMessageMedia.md b/build/docs/QueueConversationEventTopicMessageMedia.md index d68f4a6c6..e2acc341c 100644 --- a/build/docs/QueueConversationEventTopicMessageMedia.md +++ b/build/docs/QueueConversationEventTopicMessageMedia.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicMessageMetadata.md b/build/docs/QueueConversationEventTopicMessageMetadata.md index 49d33cb25..09f220291 100644 --- a/build/docs/QueueConversationEventTopicMessageMetadata.md +++ b/build/docs/QueueConversationEventTopicMessageMetadata.md @@ -13,4 +13,4 @@ Metadata information about a message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicMessageMetadataContent.md b/build/docs/QueueConversationEventTopicMessageMetadataContent.md index 9adb74ab1..4c01826d5 100644 --- a/build/docs/QueueConversationEventTopicMessageMetadataContent.md +++ b/build/docs/QueueConversationEventTopicMessageMetadataContent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicMessageMetadataEvent.md b/build/docs/QueueConversationEventTopicMessageMetadataEvent.md index b74011d63..019854dd8 100644 --- a/build/docs/QueueConversationEventTopicMessageMetadataEvent.md +++ b/build/docs/QueueConversationEventTopicMessageMetadataEvent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicMessageSticker.md b/build/docs/QueueConversationEventTopicMessageSticker.md index 4a25da122..30e5e9696 100644 --- a/build/docs/QueueConversationEventTopicMessageSticker.md +++ b/build/docs/QueueConversationEventTopicMessageSticker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicObject.md b/build/docs/QueueConversationEventTopicObject.md index c48a03220..146ccd401 100644 --- a/build/docs/QueueConversationEventTopicObject.md +++ b/build/docs/QueueConversationEventTopicObject.md @@ -10,4 +10,4 @@ The number of peer participants from the perspective of the participant in the c -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicParticipant.md b/build/docs/QueueConversationEventTopicParticipant.md index 751d767d6..7ca417809 100644 --- a/build/docs/QueueConversationEventTopicParticipant.md +++ b/build/docs/QueueConversationEventTopicParticipant.md @@ -50,4 +50,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicPhoneNumberColumn.md b/build/docs/QueueConversationEventTopicPhoneNumberColumn.md index cb5618a7d..7aaeff050 100644 --- a/build/docs/QueueConversationEventTopicPhoneNumberColumn.md +++ b/build/docs/QueueConversationEventTopicPhoneNumberColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicQueueMediaSettings.md b/build/docs/QueueConversationEventTopicQueueMediaSettings.md index 13547b7dd..71e564669 100644 --- a/build/docs/QueueConversationEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationEventTopicQueueMediaSettings.md @@ -14,4 +14,4 @@ Represents the queue setting for this media. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicScoredAgent.md b/build/docs/QueueConversationEventTopicScoredAgent.md index 2020ecd39..78067576b 100644 --- a/build/docs/QueueConversationEventTopicScoredAgent.md +++ b/build/docs/QueueConversationEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicScreenshare.md b/build/docs/QueueConversationEventTopicScreenshare.md index 3e843ae1d..5eb9c19ec 100644 --- a/build/docs/QueueConversationEventTopicScreenshare.md +++ b/build/docs/QueueConversationEventTopicScreenshare.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicSocialExpression.md b/build/docs/QueueConversationEventTopicSocialExpression.md index 35f0d3253..3b6e5d38a 100644 --- a/build/docs/QueueConversationEventTopicSocialExpression.md +++ b/build/docs/QueueConversationEventTopicSocialExpression.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicTransferDestination.md b/build/docs/QueueConversationEventTopicTransferDestination.md index 4ca5b9e95..981423114 100644 --- a/build/docs/QueueConversationEventTopicTransferDestination.md +++ b/build/docs/QueueConversationEventTopicTransferDestination.md @@ -12,4 +12,4 @@ Fields identifying the destination of a given conversation command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicTransferInitiator.md b/build/docs/QueueConversationEventTopicTransferInitiator.md index 4c772fa42..642c7eb30 100644 --- a/build/docs/QueueConversationEventTopicTransferInitiator.md +++ b/build/docs/QueueConversationEventTopicTransferInitiator.md @@ -11,4 +11,4 @@ Fields identifying the initiator of a given conversation command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicTransferModifedBy.md b/build/docs/QueueConversationEventTopicTransferModifedBy.md index e8ca3392c..b12c9e400 100644 --- a/build/docs/QueueConversationEventTopicTransferModifedBy.md +++ b/build/docs/QueueConversationEventTopicTransferModifedBy.md @@ -12,4 +12,4 @@ Fields identifying the entity that updated the command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicTransferResponse.md b/build/docs/QueueConversationEventTopicTransferResponse.md index ba8d663d1..694b13e1c 100644 --- a/build/docs/QueueConversationEventTopicTransferResponse.md +++ b/build/docs/QueueConversationEventTopicTransferResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicUriReference.md b/build/docs/QueueConversationEventTopicUriReference.md index ebb1a180d..f95eec9fa 100644 --- a/build/docs/QueueConversationEventTopicUriReference.md +++ b/build/docs/QueueConversationEventTopicUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicVideo.md b/build/docs/QueueConversationEventTopicVideo.md index db84a3fc7..c79b2539f 100644 --- a/build/docs/QueueConversationEventTopicVideo.md +++ b/build/docs/QueueConversationEventTopicVideo.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicVoicemail.md b/build/docs/QueueConversationEventTopicVoicemail.md index c98b60af6..649fb74d8 100644 --- a/build/docs/QueueConversationEventTopicVoicemail.md +++ b/build/docs/QueueConversationEventTopicVoicemail.md @@ -12,4 +12,4 @@ The voicemail data to be used when this callback is an ACD voicemail. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicWorkflow.md b/build/docs/QueueConversationEventTopicWorkflow.md index 6707bdf83..a7750b17d 100644 --- a/build/docs/QueueConversationEventTopicWorkflow.md +++ b/build/docs/QueueConversationEventTopicWorkflow.md @@ -11,4 +11,4 @@ Information about the workflow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationEventTopicWrapup.md b/build/docs/QueueConversationEventTopicWrapup.md index 6bc7a3a15..973c686f4 100644 --- a/build/docs/QueueConversationEventTopicWrapup.md +++ b/build/docs/QueueConversationEventTopicWrapup.md @@ -15,4 +15,4 @@ Call wrap up or disposition data. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationMessageEventTopicConversationDivisionMembership.md index 09f378706..6478a6494 100644 --- a/build/docs/QueueConversationMessageEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationMessageEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicConversationRoutingData.md b/build/docs/QueueConversationMessageEventTopicConversationRoutingData.md index e9db1b946..2046a7df1 100644 --- a/build/docs/QueueConversationMessageEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationMessageEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicDetail.md b/build/docs/QueueConversationMessageEventTopicDetail.md index 02f9c5ae2..b65f554df 100644 --- a/build/docs/QueueConversationMessageEventTopicDetail.md +++ b/build/docs/QueueConversationMessageEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicDivisionEntityRef.md b/build/docs/QueueConversationMessageEventTopicDivisionEntityRef.md index 761bd6b8e..06d21db99 100644 --- a/build/docs/QueueConversationMessageEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationMessageEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicDomainEntityRef.md b/build/docs/QueueConversationMessageEventTopicDomainEntityRef.md index 9db5f3167..bd245799d 100644 --- a/build/docs/QueueConversationMessageEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationMessageEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicErrorBody.md b/build/docs/QueueConversationMessageEventTopicErrorBody.md index 2a666d04c..9fca8bec9 100644 --- a/build/docs/QueueConversationMessageEventTopicErrorBody.md +++ b/build/docs/QueueConversationMessageEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicErrorDetails.md b/build/docs/QueueConversationMessageEventTopicErrorDetails.md index 59eb4cc21..3ccd20483 100644 --- a/build/docs/QueueConversationMessageEventTopicErrorDetails.md +++ b/build/docs/QueueConversationMessageEventTopicErrorDetails.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicJourneyAction.md b/build/docs/QueueConversationMessageEventTopicJourneyAction.md index 9e1670c0b..e03b4fa71 100644 --- a/build/docs/QueueConversationMessageEventTopicJourneyAction.md +++ b/build/docs/QueueConversationMessageEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicJourneyActionMap.md b/build/docs/QueueConversationMessageEventTopicJourneyActionMap.md index f51edd356..65050a4c2 100644 --- a/build/docs/QueueConversationMessageEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationMessageEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicJourneyContext.md b/build/docs/QueueConversationMessageEventTopicJourneyContext.md index f40e3130a..5a60ca0a5 100644 --- a/build/docs/QueueConversationMessageEventTopicJourneyContext.md +++ b/build/docs/QueueConversationMessageEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicJourneyCustomer.md b/build/docs/QueueConversationMessageEventTopicJourneyCustomer.md index f41b23a2b..a72d3e964 100644 --- a/build/docs/QueueConversationMessageEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationMessageEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationMessageEventTopicJourneyCustomerSession.md index d7e008485..35f35be05 100644 --- a/build/docs/QueueConversationMessageEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationMessageEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicLimit.md b/build/docs/QueueConversationMessageEventTopicLimit.md index 4786aa7e3..04c89ce58 100644 --- a/build/docs/QueueConversationMessageEventTopicLimit.md +++ b/build/docs/QueueConversationMessageEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicMessageConversation.md b/build/docs/QueueConversationMessageEventTopicMessageConversation.md index 459199837..9bf110478 100644 --- a/build/docs/QueueConversationMessageEventTopicMessageConversation.md +++ b/build/docs/QueueConversationMessageEventTopicMessageConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicMessageDetails.md b/build/docs/QueueConversationMessageEventTopicMessageDetails.md index 1084edeec..d261ff577 100644 --- a/build/docs/QueueConversationMessageEventTopicMessageDetails.md +++ b/build/docs/QueueConversationMessageEventTopicMessageDetails.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicMessageMedia.md b/build/docs/QueueConversationMessageEventTopicMessageMedia.md index 6393eb22d..adc924bf4 100644 --- a/build/docs/QueueConversationMessageEventTopicMessageMedia.md +++ b/build/docs/QueueConversationMessageEventTopicMessageMedia.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md b/build/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md index 2606cbc85..53cfe1663 100644 --- a/build/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md +++ b/build/docs/QueueConversationMessageEventTopicMessageMediaParticipant.md @@ -55,4 +55,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicMessageMetadata.md b/build/docs/QueueConversationMessageEventTopicMessageMetadata.md index 16a975675..81c7a7968 100644 --- a/build/docs/QueueConversationMessageEventTopicMessageMetadata.md +++ b/build/docs/QueueConversationMessageEventTopicMessageMetadata.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicMessageMetadataContent.md b/build/docs/QueueConversationMessageEventTopicMessageMetadataContent.md index 726a4fa6a..411c50f0e 100644 --- a/build/docs/QueueConversationMessageEventTopicMessageMetadataContent.md +++ b/build/docs/QueueConversationMessageEventTopicMessageMetadataContent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicMessageMetadataEvent.md b/build/docs/QueueConversationMessageEventTopicMessageMetadataEvent.md index 602e16820..be8f80660 100644 --- a/build/docs/QueueConversationMessageEventTopicMessageMetadataEvent.md +++ b/build/docs/QueueConversationMessageEventTopicMessageMetadataEvent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicMessageSticker.md b/build/docs/QueueConversationMessageEventTopicMessageSticker.md index fbe3c673c..4f828b65a 100644 --- a/build/docs/QueueConversationMessageEventTopicMessageSticker.md +++ b/build/docs/QueueConversationMessageEventTopicMessageSticker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicQueueMediaSettings.md b/build/docs/QueueConversationMessageEventTopicQueueMediaSettings.md index 0135b6610..286b09cf8 100644 --- a/build/docs/QueueConversationMessageEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationMessageEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicScoredAgent.md b/build/docs/QueueConversationMessageEventTopicScoredAgent.md index fb590b75c..9fcf83fd7 100644 --- a/build/docs/QueueConversationMessageEventTopicScoredAgent.md +++ b/build/docs/QueueConversationMessageEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicUriReference.md b/build/docs/QueueConversationMessageEventTopicUriReference.md index de52313cf..c474d7e7f 100644 --- a/build/docs/QueueConversationMessageEventTopicUriReference.md +++ b/build/docs/QueueConversationMessageEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationMessageEventTopicWrapup.md b/build/docs/QueueConversationMessageEventTopicWrapup.md index 6e1cf8d4b..72ab14f1a 100644 --- a/build/docs/QueueConversationMessageEventTopicWrapup.md +++ b/build/docs/QueueConversationMessageEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationScreenShareEventTopicConversationDivisionMembership.md index a6b3e841c..def9c55c2 100644 --- a/build/docs/QueueConversationScreenShareEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationScreenShareEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicConversationRoutingData.md b/build/docs/QueueConversationScreenShareEventTopicConversationRoutingData.md index b408a7806..4fcfd265d 100644 --- a/build/docs/QueueConversationScreenShareEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationScreenShareEventTopicConversationRoutingData.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicDetail.md b/build/docs/QueueConversationScreenShareEventTopicDetail.md index d1e2a9430..8c08de377 100644 --- a/build/docs/QueueConversationScreenShareEventTopicDetail.md +++ b/build/docs/QueueConversationScreenShareEventTopicDetail.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicDivisionEntityRef.md b/build/docs/QueueConversationScreenShareEventTopicDivisionEntityRef.md index 6df2dab68..f2af3fb97 100644 --- a/build/docs/QueueConversationScreenShareEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationScreenShareEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicDomainEntityRef.md b/build/docs/QueueConversationScreenShareEventTopicDomainEntityRef.md index efb859c29..100d0500a 100644 --- a/build/docs/QueueConversationScreenShareEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationScreenShareEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicErrorBody.md b/build/docs/QueueConversationScreenShareEventTopicErrorBody.md index e4526da3f..a1b1ae7d7 100644 --- a/build/docs/QueueConversationScreenShareEventTopicErrorBody.md +++ b/build/docs/QueueConversationScreenShareEventTopicErrorBody.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicJourneyAction.md b/build/docs/QueueConversationScreenShareEventTopicJourneyAction.md index 31d5423da..498e3b2fd 100644 --- a/build/docs/QueueConversationScreenShareEventTopicJourneyAction.md +++ b/build/docs/QueueConversationScreenShareEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicJourneyActionMap.md b/build/docs/QueueConversationScreenShareEventTopicJourneyActionMap.md index 4614cf661..a811bd7d6 100644 --- a/build/docs/QueueConversationScreenShareEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationScreenShareEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicJourneyContext.md b/build/docs/QueueConversationScreenShareEventTopicJourneyContext.md index ea353b55a..7a0f1004b 100644 --- a/build/docs/QueueConversationScreenShareEventTopicJourneyContext.md +++ b/build/docs/QueueConversationScreenShareEventTopicJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicJourneyCustomer.md b/build/docs/QueueConversationScreenShareEventTopicJourneyCustomer.md index 7455350ff..c297e0500 100644 --- a/build/docs/QueueConversationScreenShareEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationScreenShareEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationScreenShareEventTopicJourneyCustomerSession.md index 442a6d763..04d4e94b9 100644 --- a/build/docs/QueueConversationScreenShareEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationScreenShareEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicLimit.md b/build/docs/QueueConversationScreenShareEventTopicLimit.md index 7dbc636a4..06a574e06 100644 --- a/build/docs/QueueConversationScreenShareEventTopicLimit.md +++ b/build/docs/QueueConversationScreenShareEventTopicLimit.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicQueueMediaSettings.md b/build/docs/QueueConversationScreenShareEventTopicQueueMediaSettings.md index 289f8f29d..1c1bb97d1 100644 --- a/build/docs/QueueConversationScreenShareEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationScreenShareEventTopicQueueMediaSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicScoredAgent.md b/build/docs/QueueConversationScreenShareEventTopicScoredAgent.md index db6febc83..6c15f89f5 100644 --- a/build/docs/QueueConversationScreenShareEventTopicScoredAgent.md +++ b/build/docs/QueueConversationScreenShareEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicScreenShareConversation.md b/build/docs/QueueConversationScreenShareEventTopicScreenShareConversation.md index 74449137f..a565f9114 100644 --- a/build/docs/QueueConversationScreenShareEventTopicScreenShareConversation.md +++ b/build/docs/QueueConversationScreenShareEventTopicScreenShareConversation.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md b/build/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md index 210873c0a..a3ceded06 100644 --- a/build/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md +++ b/build/docs/QueueConversationScreenShareEventTopicScreenShareMediaParticipant.md @@ -52,4 +52,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicUriReference.md b/build/docs/QueueConversationScreenShareEventTopicUriReference.md index 464271214..69b9b6840 100644 --- a/build/docs/QueueConversationScreenShareEventTopicUriReference.md +++ b/build/docs/QueueConversationScreenShareEventTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationScreenShareEventTopicWrapup.md b/build/docs/QueueConversationScreenShareEventTopicWrapup.md index ffc8819e3..5ec41eb99 100644 --- a/build/docs/QueueConversationScreenShareEventTopicWrapup.md +++ b/build/docs/QueueConversationScreenShareEventTopicWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicAddress.md b/build/docs/QueueConversationSocialExpressionEventTopicAddress.md index e55b9b5b8..b290e012f 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicAddress.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicAddress.md @@ -15,4 +15,4 @@ Address and name data for a call endpoint. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md b/build/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md index d8c97cd72..69f808a6e 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicAfterCallWork.md @@ -13,4 +13,4 @@ A communication's after-call work data. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicAttachment.md b/build/docs/QueueConversationSocialExpressionEventTopicAttachment.md index 3bb977044..082993bdf 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicAttachment.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicAttachment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicCall.md b/build/docs/QueueConversationSocialExpressionEventTopicCall.md index 912dd0e21..73708f102 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicCall.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicCall.md @@ -39,4 +39,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicCallback.md b/build/docs/QueueConversationSocialExpressionEventTopicCallback.md index 26c3b37fb..f5878c6c3 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicCallback.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicCallback.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicChat.md b/build/docs/QueueConversationSocialExpressionEventTopicChat.md index 36ca076d0..485eea627 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicChat.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicChat.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicCobrowse.md b/build/docs/QueueConversationSocialExpressionEventTopicCobrowse.md index e0f8ad296..97041d835 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicCobrowse.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicCobrowse.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicConversation.md b/build/docs/QueueConversationSocialExpressionEventTopicConversation.md index 182ab49ff..f1559383d 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicConversation.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicConversation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationSocialExpressionEventTopicConversationDivisionMembership.md index 8567e79e7..ebe531a7e 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicConversationRoutingData.md b/build/docs/QueueConversationSocialExpressionEventTopicConversationRoutingData.md index 8afaf6b25..2a338bba0 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicConversationRoutingData.md @@ -15,4 +15,4 @@ Information on how a communication should be routed to an agent. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicDialerPreview.md b/build/docs/QueueConversationSocialExpressionEventTopicDialerPreview.md index dbbdbbd8c..7ea8fb689 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicDialerPreview.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicDialerPreview.md @@ -15,4 +15,4 @@ The preview data to be used when this callback is a Preview. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicDisconnectReason.md b/build/docs/QueueConversationSocialExpressionEventTopicDisconnectReason.md index 6d7debaed..4ce81bf33 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicDisconnectReason.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicDisconnectReason.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicDivisionEntityRef.md b/build/docs/QueueConversationSocialExpressionEventTopicDivisionEntityRef.md index b5f1fa574..9c3fe84b2 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicDomainEntityRef.md b/build/docs/QueueConversationSocialExpressionEventTopicDomainEntityRef.md index 55a3dea95..524b944f5 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicEmail.md b/build/docs/QueueConversationSocialExpressionEventTopicEmail.md index 7e525bb85..271430a43 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicEmail.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicEmail.md @@ -34,4 +34,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicErrorDetails.md b/build/docs/QueueConversationSocialExpressionEventTopicErrorDetails.md index a22109c9d..3deb8bf6d 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicErrorDetails.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicErrorDetails.md @@ -17,4 +17,4 @@ Detailed information about an error response. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicFaxStatus.md b/build/docs/QueueConversationSocialExpressionEventTopicFaxStatus.md index b9c5104c7..cc3bfe2c8 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicFaxStatus.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicFaxStatus.md @@ -18,4 +18,4 @@ Extra information on fax transmission. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicInternalMessage.md b/build/docs/QueueConversationSocialExpressionEventTopicInternalMessage.md index 8ec45ebb7..e502d1948 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicInternalMessage.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicInternalMessage.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicInternalMessageDetails.md b/build/docs/QueueConversationSocialExpressionEventTopicInternalMessageDetails.md index be1156364..7d80e179f 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicInternalMessageDetails.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicInternalMessageDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicJourneyAction.md b/build/docs/QueueConversationSocialExpressionEventTopicJourneyAction.md index 9a0fe4a49..c0fbb1db4 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicJourneyAction.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicJourneyActionMap.md b/build/docs/QueueConversationSocialExpressionEventTopicJourneyActionMap.md index 89fb7b671..030a2570b 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicJourneyContext.md b/build/docs/QueueConversationSocialExpressionEventTopicJourneyContext.md index 6245681e7..62ca687d4 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicJourneyContext.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicJourneyContext.md @@ -13,4 +13,4 @@ A subset of the Journey System's data relevant to a part of a conversation ( -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicJourneyCustomer.md b/build/docs/QueueConversationSocialExpressionEventTopicJourneyCustomer.md index 06993c68c..5136fbaf0 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationSocialExpressionEventTopicJourneyCustomerSession.md index 037747014..86007b2e1 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicMessage.md b/build/docs/QueueConversationSocialExpressionEventTopicMessage.md index 28269c143..831a4039a 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicMessage.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicMessage.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicMessageDetails.md b/build/docs/QueueConversationSocialExpressionEventTopicMessageDetails.md index be1e5421c..5306c5908 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicMessageDetails.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicMessageDetails.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicMessageMedia.md b/build/docs/QueueConversationSocialExpressionEventTopicMessageMedia.md index 1d4c5e099..168bfa944 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicMessageMedia.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicMessageMedia.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadata.md b/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadata.md index 975a75a03..2e8d1081e 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadata.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadata.md @@ -13,4 +13,4 @@ Metadata information about a message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadataContent.md b/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadataContent.md index f889709cf..6abc417d3 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadataContent.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadataContent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadataEvent.md b/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadataEvent.md index 0287f41c2..81bea6cbb 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadataEvent.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicMessageMetadataEvent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicMessageSticker.md b/build/docs/QueueConversationSocialExpressionEventTopicMessageSticker.md index 9a83c8916..dc1461b28 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicMessageSticker.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicMessageSticker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicObject.md b/build/docs/QueueConversationSocialExpressionEventTopicObject.md index 0829ccc39..62b2d6df9 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicObject.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicObject.md @@ -10,4 +10,4 @@ The number of peer participants from the perspective of the participant in the c -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicParticipant.md b/build/docs/QueueConversationSocialExpressionEventTopicParticipant.md index b5fd73cd4..f257951f0 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicParticipant.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicParticipant.md @@ -50,4 +50,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicPhoneNumberColumn.md b/build/docs/QueueConversationSocialExpressionEventTopicPhoneNumberColumn.md index 3d956a9cd..0884abfd6 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicPhoneNumberColumn.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicPhoneNumberColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicQueueMediaSettings.md b/build/docs/QueueConversationSocialExpressionEventTopicQueueMediaSettings.md index a0cefb9c1..14df8e9af 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicQueueMediaSettings.md @@ -14,4 +14,4 @@ Represents the queue setting for this media. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicScoredAgent.md b/build/docs/QueueConversationSocialExpressionEventTopicScoredAgent.md index f6e748c2a..a1051178e 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicScoredAgent.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicScreenshare.md b/build/docs/QueueConversationSocialExpressionEventTopicScreenshare.md index 7d93f8ac4..c3f484b27 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicScreenshare.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicScreenshare.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md b/build/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md index 9c4cb3a80..2a84dd766 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicSocialExpression.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicTransferDestination.md b/build/docs/QueueConversationSocialExpressionEventTopicTransferDestination.md index ed3c087d8..bcb4ce3cc 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicTransferDestination.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicTransferDestination.md @@ -12,4 +12,4 @@ Fields identifying the destination of a given conversation command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicTransferInitiator.md b/build/docs/QueueConversationSocialExpressionEventTopicTransferInitiator.md index 8be974bfa..637e9c951 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicTransferInitiator.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicTransferInitiator.md @@ -11,4 +11,4 @@ Fields identifying the initiator of a given conversation command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicTransferModifedBy.md b/build/docs/QueueConversationSocialExpressionEventTopicTransferModifedBy.md index 36017cd28..d62e86b49 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicTransferModifedBy.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicTransferModifedBy.md @@ -12,4 +12,4 @@ Fields identifying the entity that updated the command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicTransferResponse.md b/build/docs/QueueConversationSocialExpressionEventTopicTransferResponse.md index c1cb43181..128259bcb 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicTransferResponse.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicTransferResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicUriReference.md b/build/docs/QueueConversationSocialExpressionEventTopicUriReference.md index 861c90049..1b46c9287 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicUriReference.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicVideo.md b/build/docs/QueueConversationSocialExpressionEventTopicVideo.md index 39f5f1160..88e39385b 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicVideo.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicVideo.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicVoicemail.md b/build/docs/QueueConversationSocialExpressionEventTopicVoicemail.md index d8614d910..7454fdc0f 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicVoicemail.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicVoicemail.md @@ -12,4 +12,4 @@ The voicemail data to be used when this callback is an ACD voicemail. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicWorkflow.md b/build/docs/QueueConversationSocialExpressionEventTopicWorkflow.md index 5c1635ea6..cfe3132fc 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicWorkflow.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicWorkflow.md @@ -11,4 +11,4 @@ Information about the workflow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationSocialExpressionEventTopicWrapup.md b/build/docs/QueueConversationSocialExpressionEventTopicWrapup.md index 6857e3163..043123963 100644 --- a/build/docs/QueueConversationSocialExpressionEventTopicWrapup.md +++ b/build/docs/QueueConversationSocialExpressionEventTopicWrapup.md @@ -15,4 +15,4 @@ Call wrap up or disposition data. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicAddress.md b/build/docs/QueueConversationVideoEventTopicAddress.md index 3f669a684..bacd7b6ae 100644 --- a/build/docs/QueueConversationVideoEventTopicAddress.md +++ b/build/docs/QueueConversationVideoEventTopicAddress.md @@ -15,4 +15,4 @@ Address and name data for a call endpoint. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicAfterCallWork.md b/build/docs/QueueConversationVideoEventTopicAfterCallWork.md index 049b5cb61..db4758d42 100644 --- a/build/docs/QueueConversationVideoEventTopicAfterCallWork.md +++ b/build/docs/QueueConversationVideoEventTopicAfterCallWork.md @@ -13,4 +13,4 @@ A communication's after-call work data. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicAttachment.md b/build/docs/QueueConversationVideoEventTopicAttachment.md index 975a343cc..a348bf354 100644 --- a/build/docs/QueueConversationVideoEventTopicAttachment.md +++ b/build/docs/QueueConversationVideoEventTopicAttachment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicCall.md b/build/docs/QueueConversationVideoEventTopicCall.md index 49d56a0e3..fb3b1e5cf 100644 --- a/build/docs/QueueConversationVideoEventTopicCall.md +++ b/build/docs/QueueConversationVideoEventTopicCall.md @@ -39,4 +39,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicCallback.md b/build/docs/QueueConversationVideoEventTopicCallback.md index 508bc9831..970c36029 100644 --- a/build/docs/QueueConversationVideoEventTopicCallback.md +++ b/build/docs/QueueConversationVideoEventTopicCallback.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicChat.md b/build/docs/QueueConversationVideoEventTopicChat.md index 759067e8f..55d853221 100644 --- a/build/docs/QueueConversationVideoEventTopicChat.md +++ b/build/docs/QueueConversationVideoEventTopicChat.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicCobrowse.md b/build/docs/QueueConversationVideoEventTopicCobrowse.md index 0bdadbec2..eff079556 100644 --- a/build/docs/QueueConversationVideoEventTopicCobrowse.md +++ b/build/docs/QueueConversationVideoEventTopicCobrowse.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicConversation.md b/build/docs/QueueConversationVideoEventTopicConversation.md index 010376074..3f65c27bb 100644 --- a/build/docs/QueueConversationVideoEventTopicConversation.md +++ b/build/docs/QueueConversationVideoEventTopicConversation.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicConversationDivisionMembership.md b/build/docs/QueueConversationVideoEventTopicConversationDivisionMembership.md index b1cc57e30..d97999b64 100644 --- a/build/docs/QueueConversationVideoEventTopicConversationDivisionMembership.md +++ b/build/docs/QueueConversationVideoEventTopicConversationDivisionMembership.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicConversationRoutingData.md b/build/docs/QueueConversationVideoEventTopicConversationRoutingData.md index 98d9920ed..3e6729a99 100644 --- a/build/docs/QueueConversationVideoEventTopicConversationRoutingData.md +++ b/build/docs/QueueConversationVideoEventTopicConversationRoutingData.md @@ -15,4 +15,4 @@ Information on how a communication should be routed to an agent. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicDialerPreview.md b/build/docs/QueueConversationVideoEventTopicDialerPreview.md index 72374be0c..1ddb55b8d 100644 --- a/build/docs/QueueConversationVideoEventTopicDialerPreview.md +++ b/build/docs/QueueConversationVideoEventTopicDialerPreview.md @@ -15,4 +15,4 @@ The preview data to be used when this callback is a Preview. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicDisconnectReason.md b/build/docs/QueueConversationVideoEventTopicDisconnectReason.md index 87d85e90d..b850ea8de 100644 --- a/build/docs/QueueConversationVideoEventTopicDisconnectReason.md +++ b/build/docs/QueueConversationVideoEventTopicDisconnectReason.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicDivisionEntityRef.md b/build/docs/QueueConversationVideoEventTopicDivisionEntityRef.md index 3b7d73b9b..21ff961f9 100644 --- a/build/docs/QueueConversationVideoEventTopicDivisionEntityRef.md +++ b/build/docs/QueueConversationVideoEventTopicDivisionEntityRef.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicDomainEntityRef.md b/build/docs/QueueConversationVideoEventTopicDomainEntityRef.md index b4f3a438b..a91adc057 100644 --- a/build/docs/QueueConversationVideoEventTopicDomainEntityRef.md +++ b/build/docs/QueueConversationVideoEventTopicDomainEntityRef.md @@ -12,4 +12,4 @@ A reference to another domain entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicEmail.md b/build/docs/QueueConversationVideoEventTopicEmail.md index 6cb417e86..e9a02410c 100644 --- a/build/docs/QueueConversationVideoEventTopicEmail.md +++ b/build/docs/QueueConversationVideoEventTopicEmail.md @@ -34,4 +34,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicErrorDetails.md b/build/docs/QueueConversationVideoEventTopicErrorDetails.md index 9114f78c2..6eac11c14 100644 --- a/build/docs/QueueConversationVideoEventTopicErrorDetails.md +++ b/build/docs/QueueConversationVideoEventTopicErrorDetails.md @@ -17,4 +17,4 @@ Detailed information about an error response. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicFaxStatus.md b/build/docs/QueueConversationVideoEventTopicFaxStatus.md index 2769e6ef5..8367b5688 100644 --- a/build/docs/QueueConversationVideoEventTopicFaxStatus.md +++ b/build/docs/QueueConversationVideoEventTopicFaxStatus.md @@ -18,4 +18,4 @@ Extra information on fax transmission. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicInternalMessage.md b/build/docs/QueueConversationVideoEventTopicInternalMessage.md index e95ecf071..c9f53a250 100644 --- a/build/docs/QueueConversationVideoEventTopicInternalMessage.md +++ b/build/docs/QueueConversationVideoEventTopicInternalMessage.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicInternalMessageDetails.md b/build/docs/QueueConversationVideoEventTopicInternalMessageDetails.md index 45c2f3190..9aebea1ae 100644 --- a/build/docs/QueueConversationVideoEventTopicInternalMessageDetails.md +++ b/build/docs/QueueConversationVideoEventTopicInternalMessageDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicJourneyAction.md b/build/docs/QueueConversationVideoEventTopicJourneyAction.md index 1c8ee0024..47a0e3682 100644 --- a/build/docs/QueueConversationVideoEventTopicJourneyAction.md +++ b/build/docs/QueueConversationVideoEventTopicJourneyAction.md @@ -12,4 +12,4 @@ A subset of the Journey System's action data relevant to a part of a convers -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicJourneyActionMap.md b/build/docs/QueueConversationVideoEventTopicJourneyActionMap.md index a97c137cf..c108954f0 100644 --- a/build/docs/QueueConversationVideoEventTopicJourneyActionMap.md +++ b/build/docs/QueueConversationVideoEventTopicJourneyActionMap.md @@ -12,4 +12,4 @@ Details about the action map from the Journey System which triggered this action -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicJourneyContext.md b/build/docs/QueueConversationVideoEventTopicJourneyContext.md index 015fb864b..0f4dbd6fa 100644 --- a/build/docs/QueueConversationVideoEventTopicJourneyContext.md +++ b/build/docs/QueueConversationVideoEventTopicJourneyContext.md @@ -13,4 +13,4 @@ A subset of the Journey System's data relevant to a part of a conversation ( -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicJourneyCustomer.md b/build/docs/QueueConversationVideoEventTopicJourneyCustomer.md index fe0a35443..730255494 100644 --- a/build/docs/QueueConversationVideoEventTopicJourneyCustomer.md +++ b/build/docs/QueueConversationVideoEventTopicJourneyCustomer.md @@ -12,4 +12,4 @@ A subset of the Journey System's customer data at a point-in-time (for exter -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicJourneyCustomerSession.md b/build/docs/QueueConversationVideoEventTopicJourneyCustomerSession.md index 6e001c0d0..c63eadfe2 100644 --- a/build/docs/QueueConversationVideoEventTopicJourneyCustomerSession.md +++ b/build/docs/QueueConversationVideoEventTopicJourneyCustomerSession.md @@ -12,4 +12,4 @@ A subset of the Journey System's tracked customer session data at a point-in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicMessage.md b/build/docs/QueueConversationVideoEventTopicMessage.md index 111808d37..82b7c2b61 100644 --- a/build/docs/QueueConversationVideoEventTopicMessage.md +++ b/build/docs/QueueConversationVideoEventTopicMessage.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicMessageDetails.md b/build/docs/QueueConversationVideoEventTopicMessageDetails.md index e0cb3f163..dcac458ca 100644 --- a/build/docs/QueueConversationVideoEventTopicMessageDetails.md +++ b/build/docs/QueueConversationVideoEventTopicMessageDetails.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicMessageMedia.md b/build/docs/QueueConversationVideoEventTopicMessageMedia.md index 398391620..c72df31d5 100644 --- a/build/docs/QueueConversationVideoEventTopicMessageMedia.md +++ b/build/docs/QueueConversationVideoEventTopicMessageMedia.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicMessageMetadata.md b/build/docs/QueueConversationVideoEventTopicMessageMetadata.md index fe0fd0bb3..c3a59ab42 100644 --- a/build/docs/QueueConversationVideoEventTopicMessageMetadata.md +++ b/build/docs/QueueConversationVideoEventTopicMessageMetadata.md @@ -13,4 +13,4 @@ Metadata information about a message. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicMessageMetadataContent.md b/build/docs/QueueConversationVideoEventTopicMessageMetadataContent.md index 40c1d7f7c..15ddc02ef 100644 --- a/build/docs/QueueConversationVideoEventTopicMessageMetadataContent.md +++ b/build/docs/QueueConversationVideoEventTopicMessageMetadataContent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicMessageMetadataEvent.md b/build/docs/QueueConversationVideoEventTopicMessageMetadataEvent.md index ac5221ad1..d8530572b 100644 --- a/build/docs/QueueConversationVideoEventTopicMessageMetadataEvent.md +++ b/build/docs/QueueConversationVideoEventTopicMessageMetadataEvent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicMessageSticker.md b/build/docs/QueueConversationVideoEventTopicMessageSticker.md index dc932e054..b31121321 100644 --- a/build/docs/QueueConversationVideoEventTopicMessageSticker.md +++ b/build/docs/QueueConversationVideoEventTopicMessageSticker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicObject.md b/build/docs/QueueConversationVideoEventTopicObject.md index 90a28acc9..138e11295 100644 --- a/build/docs/QueueConversationVideoEventTopicObject.md +++ b/build/docs/QueueConversationVideoEventTopicObject.md @@ -10,4 +10,4 @@ The number of peer participants from the perspective of the participant in the c -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicParticipant.md b/build/docs/QueueConversationVideoEventTopicParticipant.md index 5509b0106..28a2e860e 100644 --- a/build/docs/QueueConversationVideoEventTopicParticipant.md +++ b/build/docs/QueueConversationVideoEventTopicParticipant.md @@ -50,4 +50,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicPhoneNumberColumn.md b/build/docs/QueueConversationVideoEventTopicPhoneNumberColumn.md index 8fe69c133..6b7c322d1 100644 --- a/build/docs/QueueConversationVideoEventTopicPhoneNumberColumn.md +++ b/build/docs/QueueConversationVideoEventTopicPhoneNumberColumn.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicQueueMediaSettings.md b/build/docs/QueueConversationVideoEventTopicQueueMediaSettings.md index 37e21d79a..317d868c7 100644 --- a/build/docs/QueueConversationVideoEventTopicQueueMediaSettings.md +++ b/build/docs/QueueConversationVideoEventTopicQueueMediaSettings.md @@ -14,4 +14,4 @@ Represents the queue setting for this media. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicScoredAgent.md b/build/docs/QueueConversationVideoEventTopicScoredAgent.md index 9f1b5a25a..629b63ff9 100644 --- a/build/docs/QueueConversationVideoEventTopicScoredAgent.md +++ b/build/docs/QueueConversationVideoEventTopicScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicScreenshare.md b/build/docs/QueueConversationVideoEventTopicScreenshare.md index a2f21ddde..1e23d3475 100644 --- a/build/docs/QueueConversationVideoEventTopicScreenshare.md +++ b/build/docs/QueueConversationVideoEventTopicScreenshare.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicSocialExpression.md b/build/docs/QueueConversationVideoEventTopicSocialExpression.md index 2e18ba55a..a012923e9 100644 --- a/build/docs/QueueConversationVideoEventTopicSocialExpression.md +++ b/build/docs/QueueConversationVideoEventTopicSocialExpression.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicTransferDestination.md b/build/docs/QueueConversationVideoEventTopicTransferDestination.md index b94f8615c..0faa897a3 100644 --- a/build/docs/QueueConversationVideoEventTopicTransferDestination.md +++ b/build/docs/QueueConversationVideoEventTopicTransferDestination.md @@ -12,4 +12,4 @@ Fields identifying the destination of a given conversation command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicTransferInitiator.md b/build/docs/QueueConversationVideoEventTopicTransferInitiator.md index 2490e1a70..17a9790ef 100644 --- a/build/docs/QueueConversationVideoEventTopicTransferInitiator.md +++ b/build/docs/QueueConversationVideoEventTopicTransferInitiator.md @@ -11,4 +11,4 @@ Fields identifying the initiator of a given conversation command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicTransferModifedBy.md b/build/docs/QueueConversationVideoEventTopicTransferModifedBy.md index bd45a5bee..2a9834542 100644 --- a/build/docs/QueueConversationVideoEventTopicTransferModifedBy.md +++ b/build/docs/QueueConversationVideoEventTopicTransferModifedBy.md @@ -12,4 +12,4 @@ Fields identifying the entity that updated the command. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicTransferResponse.md b/build/docs/QueueConversationVideoEventTopicTransferResponse.md index fda51317a..4397a6d40 100644 --- a/build/docs/QueueConversationVideoEventTopicTransferResponse.md +++ b/build/docs/QueueConversationVideoEventTopicTransferResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicUriReference.md b/build/docs/QueueConversationVideoEventTopicUriReference.md index 6a0e52569..17b627ea4 100644 --- a/build/docs/QueueConversationVideoEventTopicUriReference.md +++ b/build/docs/QueueConversationVideoEventTopicUriReference.md @@ -12,4 +12,4 @@ A UriReference for a resource -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicVideo.md b/build/docs/QueueConversationVideoEventTopicVideo.md index 49f859255..0f9988984 100644 --- a/build/docs/QueueConversationVideoEventTopicVideo.md +++ b/build/docs/QueueConversationVideoEventTopicVideo.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicVoicemail.md b/build/docs/QueueConversationVideoEventTopicVoicemail.md index 44b350006..0fe079305 100644 --- a/build/docs/QueueConversationVideoEventTopicVoicemail.md +++ b/build/docs/QueueConversationVideoEventTopicVoicemail.md @@ -12,4 +12,4 @@ The voicemail data to be used when this callback is an ACD voicemail. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicWorkflow.md b/build/docs/QueueConversationVideoEventTopicWorkflow.md index 880a608cc..d368af2dc 100644 --- a/build/docs/QueueConversationVideoEventTopicWorkflow.md +++ b/build/docs/QueueConversationVideoEventTopicWorkflow.md @@ -11,4 +11,4 @@ Information about the workflow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueConversationVideoEventTopicWrapup.md b/build/docs/QueueConversationVideoEventTopicWrapup.md index 3dd878670..7dd77fff1 100644 --- a/build/docs/QueueConversationVideoEventTopicWrapup.md +++ b/build/docs/QueueConversationVideoEventTopicWrapup.md @@ -15,4 +15,4 @@ Call wrap up or disposition data. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueEmailAddress.md b/build/docs/QueueEmailAddress.md index aa1c52461..16e30fcb8 100644 --- a/build/docs/QueueEmailAddress.md +++ b/build/docs/QueueEmailAddress.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueEntityListing.md b/build/docs/QueueEntityListing.md index 9a4ab2601..e9e9ec8f8 100644 --- a/build/docs/QueueEntityListing.md +++ b/build/docs/QueueEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueMediaSettings.md b/build/docs/QueueMediaSettings.md index 8fcfa838f..30b4ca5e8 100644 --- a/build/docs/QueueMediaSettings.md +++ b/build/docs/QueueMediaSettings.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueMember.md b/build/docs/QueueMember.md index 4b78f2a5a..3b41e192d 100644 --- a/build/docs/QueueMember.md +++ b/build/docs/QueueMember.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueMemberEntityListing.md b/build/docs/QueueMemberEntityListing.md index 3e560b6d9..39aba714a 100644 --- a/build/docs/QueueMemberEntityListing.md +++ b/build/docs/QueueMemberEntityListing.md @@ -9,11 +9,11 @@ | **entities** | [**[QueueMember]**](QueueMember) | | [optional] | | **pageNumber** | **Int** | | [optional] | | **pageSize** | **Int** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueMemberEntityListingV1.md b/build/docs/QueueMemberEntityListingV1.md index 201707bd4..b1182f091 100644 --- a/build/docs/QueueMemberEntityListingV1.md +++ b/build/docs/QueueMemberEntityListingV1.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueMessagingAddresses.md b/build/docs/QueueMessagingAddresses.md index 6e38e93a6..452fcd2b1 100644 --- a/build/docs/QueueMessagingAddresses.md +++ b/build/docs/QueueMessagingAddresses.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueObservationDataContainer.md b/build/docs/QueueObservationDataContainer.md index 8f061a3f8..0b4eef7e1 100644 --- a/build/docs/QueueObservationDataContainer.md +++ b/build/docs/QueueObservationDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueObservationQuery.md b/build/docs/QueueObservationQuery.md index 28b50d99a..7e70bc4b1 100644 --- a/build/docs/QueueObservationQuery.md +++ b/build/docs/QueueObservationQuery.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueObservationQueryClause.md b/build/docs/QueueObservationQueryClause.md index b1c026920..84034318d 100644 --- a/build/docs/QueueObservationQueryClause.md +++ b/build/docs/QueueObservationQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueObservationQueryFilter.md b/build/docs/QueueObservationQueryFilter.md index f5b7d30bb..3cf860af9 100644 --- a/build/docs/QueueObservationQueryFilter.md +++ b/build/docs/QueueObservationQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueObservationQueryPredicate.md b/build/docs/QueueObservationQueryPredicate.md index 000d76b27..3dbd2f38b 100644 --- a/build/docs/QueueObservationQueryPredicate.md +++ b/build/docs/QueueObservationQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueObservationQueryResponse.md b/build/docs/QueueObservationQueryResponse.md index 9542ff19b..e6f8bcd8b 100644 --- a/build/docs/QueueObservationQueryResponse.md +++ b/build/docs/QueueObservationQueryResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueReference.md b/build/docs/QueueReference.md index 028c2e4dd..30beadda9 100644 --- a/build/docs/QueueReference.md +++ b/build/docs/QueueReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueRequest.md b/build/docs/QueueRequest.md index f2204e5d7..2e1dd52f8 100644 --- a/build/docs/QueueRequest.md +++ b/build/docs/QueueRequest.md @@ -48,4 +48,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueUserEventTopicObject.md b/build/docs/QueueUserEventTopicObject.md index 4f38bc0a6..e9fe47a69 100644 --- a/build/docs/QueueUserEventTopicObject.md +++ b/build/docs/QueueUserEventTopicObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueUserEventTopicQueueMember.md b/build/docs/QueueUserEventTopicQueueMember.md index 9a6944fff..9435dd6e7 100644 --- a/build/docs/QueueUserEventTopicQueueMember.md +++ b/build/docs/QueueUserEventTopicQueueMember.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueUserEventTopicUserReference.md b/build/docs/QueueUserEventTopicUserReference.md index d5f169d99..8bab93082 100644 --- a/build/docs/QueueUserEventTopicUserReference.md +++ b/build/docs/QueueUserEventTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QueueUtilizationDiagnostic.md b/build/docs/QueueUtilizationDiagnostic.md index 88dfab063..4f2f1ea77 100644 --- a/build/docs/QueueUtilizationDiagnostic.md +++ b/build/docs/QueueUtilizationDiagnostic.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/QuickReply.md b/build/docs/QuickReply.md index d9167a14a..8aba34b63 100644 --- a/build/docs/QuickReply.md +++ b/build/docs/QuickReply.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Range.md b/build/docs/Range.md index a479a6809..318a51dd9 100644 --- a/build/docs/Range.md +++ b/build/docs/Range.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RateLimitAggregateDataContainer.md b/build/docs/RateLimitAggregateDataContainer.md index 31f39a785..00d0c5802 100644 --- a/build/docs/RateLimitAggregateDataContainer.md +++ b/build/docs/RateLimitAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RateLimitAggregateQueryClause.md b/build/docs/RateLimitAggregateQueryClause.md index f0e9c7b97..60d6ecf05 100644 --- a/build/docs/RateLimitAggregateQueryClause.md +++ b/build/docs/RateLimitAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RateLimitAggregateQueryFilter.md b/build/docs/RateLimitAggregateQueryFilter.md index 559837ad0..1b0910c6a 100644 --- a/build/docs/RateLimitAggregateQueryFilter.md +++ b/build/docs/RateLimitAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RateLimitAggregateQueryPredicate.md b/build/docs/RateLimitAggregateQueryPredicate.md index 5b962e46f..e247e8028 100644 --- a/build/docs/RateLimitAggregateQueryPredicate.md +++ b/build/docs/RateLimitAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RateLimitAggregateQueryResponse.md b/build/docs/RateLimitAggregateQueryResponse.md index 255784c5a..f88803c72 100644 --- a/build/docs/RateLimitAggregateQueryResponse.md +++ b/build/docs/RateLimitAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RateLimitAggregationQuery.md b/build/docs/RateLimitAggregationQuery.md index 1fbd46528..4e66c8190 100644 --- a/build/docs/RateLimitAggregationQuery.md +++ b/build/docs/RateLimitAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RateLimitAggregationView.md b/build/docs/RateLimitAggregationView.md index 5871793cc..aa7140f11 100644 --- a/build/docs/RateLimitAggregationView.md +++ b/build/docs/RateLimitAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Reaction.md b/build/docs/Reaction.md index 276590aaf..4084fc89c 100644 --- a/build/docs/Reaction.md +++ b/build/docs/Reaction.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RealTimeAdherenceExplanation.md b/build/docs/RealTimeAdherenceExplanation.md index 2296adcd5..4dcb86d05 100644 --- a/build/docs/RealTimeAdherenceExplanation.md +++ b/build/docs/RealTimeAdherenceExplanation.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecallEntry.md b/build/docs/RecallEntry.md index cf56fcd04..f65ed905d 100644 --- a/build/docs/RecallEntry.md +++ b/build/docs/RecallEntry.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Recipient.md b/build/docs/Recipient.md index 59aed51dc..69c3e771c 100644 --- a/build/docs/Recipient.md +++ b/build/docs/Recipient.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecipientAdditionalIdentifier.md b/build/docs/RecipientAdditionalIdentifier.md index 696d07701..a0489eae9 100644 --- a/build/docs/RecipientAdditionalIdentifier.md +++ b/build/docs/RecipientAdditionalIdentifier.md @@ -12,4 +12,4 @@ Additional identifiers for describing messaging recipient. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecipientFlow.md b/build/docs/RecipientFlow.md index 153cb9b27..4c518f224 100644 --- a/build/docs/RecipientFlow.md +++ b/build/docs/RecipientFlow.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecipientListing.md b/build/docs/RecipientListing.md index 28ef1047d..7045bc86c 100644 --- a/build/docs/RecipientListing.md +++ b/build/docs/RecipientListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecipientRequest.md b/build/docs/RecipientRequest.md index 04696bc47..7d7f57933 100644 --- a/build/docs/RecipientRequest.md +++ b/build/docs/RecipientRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Recognition.md b/build/docs/Recognition.md index 3883c2cf1..dad93dd02 100644 --- a/build/docs/Recognition.md +++ b/build/docs/Recognition.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecognitionBase.md b/build/docs/RecognitionBase.md index 7d00a3432..9c7fbf6e9 100644 --- a/build/docs/RecognitionBase.md +++ b/build/docs/RecognitionBase.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Record.md b/build/docs/Record.md index 0c5f9f872..6a5f35198 100644 --- a/build/docs/Record.md +++ b/build/docs/Record.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Recording.md b/build/docs/Recording.md index d8c4d005c..f910e1f36 100644 --- a/build/docs/Recording.md +++ b/build/docs/Recording.md @@ -43,4 +43,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingAPI.md b/build/docs/RecordingAPI.md index a214f5be7..b50806e7b 100644 --- a/build/docs/RecordingAPI.md +++ b/build/docs/RecordingAPI.md @@ -3199,4 +3199,4 @@ RecordingAPI.putRecordingsDeletionprotection(protect: protect, body: body) { (er `nil` (empty response body) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingAnnotationFlow.md b/build/docs/RecordingAnnotationFlow.md index 93155dea9..d49f1b537 100644 --- a/build/docs/RecordingAnnotationFlow.md +++ b/build/docs/RecordingAnnotationFlow.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingAnnotationQueue.md b/build/docs/RecordingAnnotationQueue.md index a7e9df600..150551906 100644 --- a/build/docs/RecordingAnnotationQueue.md +++ b/build/docs/RecordingAnnotationQueue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingArchiveRestoreTopicMediaResult.md b/build/docs/RecordingArchiveRestoreTopicMediaResult.md index 23ebf65ed..313d6448e 100644 --- a/build/docs/RecordingArchiveRestoreTopicMediaResult.md +++ b/build/docs/RecordingArchiveRestoreTopicMediaResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingArchiveRestoreTopicRecording.md b/build/docs/RecordingArchiveRestoreTopicRecording.md index 22e3ab9cf..111088930 100644 --- a/build/docs/RecordingArchiveRestoreTopicRecording.md +++ b/build/docs/RecordingArchiveRestoreTopicRecording.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingAttachment.md b/build/docs/RecordingAttachment.md index 0c97cf609..8930c5315 100644 --- a/build/docs/RecordingAttachment.md +++ b/build/docs/RecordingAttachment.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingButtonComponent.md b/build/docs/RecordingButtonComponent.md index 2af4301c7..8a6272b19 100644 --- a/build/docs/RecordingButtonComponent.md +++ b/build/docs/RecordingButtonComponent.md @@ -13,4 +13,4 @@ Structured template button object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingContentActions.md b/build/docs/RecordingContentActions.md index 503edcaaf..326846a9d 100644 --- a/build/docs/RecordingContentActions.md +++ b/build/docs/RecordingContentActions.md @@ -13,4 +13,4 @@ User actions available on the content. All actions are optional and all actions -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingContentStory.md b/build/docs/RecordingContentStory.md index 1380a9bef..3574f98c1 100644 --- a/build/docs/RecordingContentStory.md +++ b/build/docs/RecordingContentStory.md @@ -13,4 +13,4 @@ Story object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingEmailMessage.md b/build/docs/RecordingEmailMessage.md index c51316b18..270305a96 100644 --- a/build/docs/RecordingEmailMessage.md +++ b/build/docs/RecordingEmailMessage.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingEncryptionConfiguration.md b/build/docs/RecordingEncryptionConfiguration.md index 4298539ad..6a9e33260 100644 --- a/build/docs/RecordingEncryptionConfiguration.md +++ b/build/docs/RecordingEncryptionConfiguration.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingEncryptionConfigurationListing.md b/build/docs/RecordingEncryptionConfigurationListing.md index 7d596d08e..7be2139f8 100644 --- a/build/docs/RecordingEncryptionConfigurationListing.md +++ b/build/docs/RecordingEncryptionConfigurationListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingEventMediaResult.md b/build/docs/RecordingEventMediaResult.md index 8fd686d92..a47297a9d 100644 --- a/build/docs/RecordingEventMediaResult.md +++ b/build/docs/RecordingEventMediaResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingEventRecording.md b/build/docs/RecordingEventRecording.md index 7f08bba7e..1450693ab 100644 --- a/build/docs/RecordingEventRecording.md +++ b/build/docs/RecordingEventRecording.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingJob.md b/build/docs/RecordingJob.md index acf7a0c54..e55e23236 100644 --- a/build/docs/RecordingJob.md +++ b/build/docs/RecordingJob.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingJobEntityListing.md b/build/docs/RecordingJobEntityListing.md index c1b266edf..2fdfe4e6e 100644 --- a/build/docs/RecordingJobEntityListing.md +++ b/build/docs/RecordingJobEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingJobFailedRecording.md b/build/docs/RecordingJobFailedRecording.md index 336dc383b..3a18bc4c5 100644 --- a/build/docs/RecordingJobFailedRecording.md +++ b/build/docs/RecordingJobFailedRecording.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingJobsQuery.md b/build/docs/RecordingJobsQuery.md index df128ea3a..65991ba6a 100644 --- a/build/docs/RecordingJobsQuery.md +++ b/build/docs/RecordingJobsQuery.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingMessagingMessage.md b/build/docs/RecordingMessagingMessage.md index b6a544b10..c2c18a7e3 100644 --- a/build/docs/RecordingMessagingMessage.md +++ b/build/docs/RecordingMessagingMessage.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingMetadata.md b/build/docs/RecordingMetadata.md index e37437030..d1119c350 100644 --- a/build/docs/RecordingMetadata.md +++ b/build/docs/RecordingMetadata.md @@ -30,4 +30,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingNotificationTemplate.md b/build/docs/RecordingNotificationTemplate.md index 1ec902245..66bacb783 100644 --- a/build/docs/RecordingNotificationTemplate.md +++ b/build/docs/RecordingNotificationTemplate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingRetention.md b/build/docs/RecordingRetention.md index bfda76a2d..cb5718f04 100644 --- a/build/docs/RecordingRetention.md +++ b/build/docs/RecordingRetention.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingRetentionCursorEntityListing.md b/build/docs/RecordingRetentionCursorEntityListing.md index d1f5de93c..44cba7791 100644 --- a/build/docs/RecordingRetentionCursorEntityListing.md +++ b/build/docs/RecordingRetentionCursorEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingSettings.md b/build/docs/RecordingSettings.md index 2f54b201f..0cb6307a9 100644 --- a/build/docs/RecordingSettings.md +++ b/build/docs/RecordingSettings.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingTemplateBody.md b/build/docs/RecordingTemplateBody.md index 26f221e3f..f981fcdf7 100644 --- a/build/docs/RecordingTemplateBody.md +++ b/build/docs/RecordingTemplateBody.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingTemplateButton.md b/build/docs/RecordingTemplateButton.md index 8c8bda15a..bd2146544 100644 --- a/build/docs/RecordingTemplateButton.md +++ b/build/docs/RecordingTemplateButton.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingTemplateFooter.md b/build/docs/RecordingTemplateFooter.md index 1d69a83d0..a611ce1f5 100644 --- a/build/docs/RecordingTemplateFooter.md +++ b/build/docs/RecordingTemplateFooter.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingTemplateHeader.md b/build/docs/RecordingTemplateHeader.md index 077d9dd04..2a00b4932 100644 --- a/build/docs/RecordingTemplateHeader.md +++ b/build/docs/RecordingTemplateHeader.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingTranscodeCompleteTopicMediaResult.md b/build/docs/RecordingTranscodeCompleteTopicMediaResult.md index d100f13e2..cea012457 100644 --- a/build/docs/RecordingTranscodeCompleteTopicMediaResult.md +++ b/build/docs/RecordingTranscodeCompleteTopicMediaResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingTranscodeCompleteTopicRecording.md b/build/docs/RecordingTranscodeCompleteTopicRecording.md index 7fd7ab3e4..312ffcc74 100644 --- a/build/docs/RecordingTranscodeCompleteTopicRecording.md +++ b/build/docs/RecordingTranscodeCompleteTopicRecording.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingUploadReport.md b/build/docs/RecordingUploadReport.md index b04572974..09f795d14 100644 --- a/build/docs/RecordingUploadReport.md +++ b/build/docs/RecordingUploadReport.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecordingUploadReportRequest.md b/build/docs/RecordingUploadReportRequest.md index d91f20526..ab367c9e7 100644 --- a/build/docs/RecordingUploadReportRequest.md +++ b/build/docs/RecordingUploadReportRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecurrenceEndSettings.md b/build/docs/RecurrenceEndSettings.md index 110ab98b6..30b96b2bc 100644 --- a/build/docs/RecurrenceEndSettings.md +++ b/build/docs/RecurrenceEndSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecurrencePeriod.md b/build/docs/RecurrencePeriod.md index ee892413f..ebf686826 100644 --- a/build/docs/RecurrencePeriod.md +++ b/build/docs/RecurrencePeriod.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RecurrenceSettings.md b/build/docs/RecurrenceSettings.md index a4170d688..d406a8ef7 100644 --- a/build/docs/RecurrenceSettings.md +++ b/build/docs/RecurrenceSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Referrer.md b/build/docs/Referrer.md index 154bbc99c..f52b002c8 100644 --- a/build/docs/Referrer.md +++ b/build/docs/Referrer.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RegionTimeZone.md b/build/docs/RegionTimeZone.md index 1d1f7db80..3b980f714 100644 --- a/build/docs/RegionTimeZone.md +++ b/build/docs/RegionTimeZone.md @@ -9,8 +9,9 @@ | **_id** | **String** | The globally unique identifier for the object. | [optional] | | **name** | **String** | | [optional] | | **offset** | **Int64** | | [optional] | +| **canonicalId** | **String** | Canonical identifier for this time zone, if applicable | [optional] | | **selfUri** | **String** | The URI for this object | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RegisterArchitectJobResponse.md b/build/docs/RegisterArchitectJobResponse.md index d04ba52d8..9c09e33f6 100644 --- a/build/docs/RegisterArchitectJobResponse.md +++ b/build/docs/RegisterArchitectJobResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Relationship.md b/build/docs/Relationship.md index 0863d9297..c6192af35 100644 --- a/build/docs/Relationship.md +++ b/build/docs/Relationship.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RelationshipListing.md b/build/docs/RelationshipListing.md index 2be0bd28c..ed6385996 100644 --- a/build/docs/RelationshipListing.md +++ b/build/docs/RelationshipListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **partialResults** | **Bool** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Reoccurrence.md b/build/docs/Reoccurrence.md index b8fe27e69..31b21b733 100644 --- a/build/docs/Reoccurrence.md +++ b/build/docs/Reoccurrence.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReplaceRequest.md b/build/docs/ReplaceRequest.md index def42a09d..294937fca 100644 --- a/build/docs/ReplaceRequest.md +++ b/build/docs/ReplaceRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReplaceResponse.md b/build/docs/ReplaceResponse.md index 03dd50228..c4e66713b 100644 --- a/build/docs/ReplaceResponse.md +++ b/build/docs/ReplaceResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReplacementTerm.md b/build/docs/ReplacementTerm.md index e3b4b8680..0215c4117 100644 --- a/build/docs/ReplacementTerm.md +++ b/build/docs/ReplacementTerm.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReplyToEmailAddress.md b/build/docs/ReplyToEmailAddress.md index 5686c977c..4e6ea7642 100644 --- a/build/docs/ReplyToEmailAddress.md +++ b/build/docs/ReplyToEmailAddress.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingDataExportTopicDataExportNotification.md b/build/docs/ReportingDataExportTopicDataExportNotification.md index ac3f4ac71..ba0f9f801 100644 --- a/build/docs/ReportingDataExportTopicDataExportNotification.md +++ b/build/docs/ReportingDataExportTopicDataExportNotification.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingExportJobListing.md b/build/docs/ReportingExportJobListing.md index 7cf9d6250..a37d48c2e 100644 --- a/build/docs/ReportingExportJobListing.md +++ b/build/docs/ReportingExportJobListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingExportJobRequest.md b/build/docs/ReportingExportJobRequest.md index 95d554beb..89f193d17 100644 --- a/build/docs/ReportingExportJobRequest.md +++ b/build/docs/ReportingExportJobRequest.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingExportJobResponse.md b/build/docs/ReportingExportJobResponse.md index e6c1526d2..72786fc09 100644 --- a/build/docs/ReportingExportJobResponse.md +++ b/build/docs/ReportingExportJobResponse.md @@ -42,4 +42,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingExportMetadataJobListing.md b/build/docs/ReportingExportMetadataJobListing.md index 6a3788197..21e4b1056 100644 --- a/build/docs/ReportingExportMetadataJobListing.md +++ b/build/docs/ReportingExportMetadataJobListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingExportMetadataJobResponse.md b/build/docs/ReportingExportMetadataJobResponse.md index a57aad9ce..34859e8f6 100644 --- a/build/docs/ReportingExportMetadataJobResponse.md +++ b/build/docs/ReportingExportMetadataJobResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingInterval.md b/build/docs/ReportingInterval.md index f3c9d6161..65c8bd420 100644 --- a/build/docs/ReportingInterval.md +++ b/build/docs/ReportingInterval.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurn.md b/build/docs/ReportingTurn.md index 524387587..d32e78e5c 100644 --- a/build/docs/ReportingTurn.md +++ b/build/docs/ReportingTurn.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnAction.md b/build/docs/ReportingTurnAction.md index b0c5c4e92..0a77811fc 100644 --- a/build/docs/ReportingTurnAction.md +++ b/build/docs/ReportingTurnAction.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnIntent.md b/build/docs/ReportingTurnIntent.md index 466d2bbe1..20dcc796f 100644 --- a/build/docs/ReportingTurnIntent.md +++ b/build/docs/ReportingTurnIntent.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnIntentSlot.md b/build/docs/ReportingTurnIntentSlot.md index 8dd0f76ed..b5a4d537c 100644 --- a/build/docs/ReportingTurnIntentSlot.md +++ b/build/docs/ReportingTurnIntentSlot.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnKnowledge.md b/build/docs/ReportingTurnKnowledge.md index 018fb3d9f..7db3f5e1e 100644 --- a/build/docs/ReportingTurnKnowledge.md +++ b/build/docs/ReportingTurnKnowledge.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnKnowledgeDocument.md b/build/docs/ReportingTurnKnowledgeDocument.md index ba04cb426..fceab4a2a 100644 --- a/build/docs/ReportingTurnKnowledgeDocument.md +++ b/build/docs/ReportingTurnKnowledgeDocument.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnKnowledgeEvents.md b/build/docs/ReportingTurnKnowledgeEvents.md index 88883f764..69ef4ff4a 100644 --- a/build/docs/ReportingTurnKnowledgeEvents.md +++ b/build/docs/ReportingTurnKnowledgeEvents.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnKnowledgeFeedback.md b/build/docs/ReportingTurnKnowledgeFeedback.md index 3ae2d0cdd..9c1f341d1 100644 --- a/build/docs/ReportingTurnKnowledgeFeedback.md +++ b/build/docs/ReportingTurnKnowledgeFeedback.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnKnowledgeFeedbackEvent.md b/build/docs/ReportingTurnKnowledgeFeedbackEvent.md index 9c52ab5ff..d6c84b22b 100644 --- a/build/docs/ReportingTurnKnowledgeFeedbackEvent.md +++ b/build/docs/ReportingTurnKnowledgeFeedbackEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnKnowledgeSearch.md b/build/docs/ReportingTurnKnowledgeSearch.md index 22fa6567c..d4d3c74cf 100644 --- a/build/docs/ReportingTurnKnowledgeSearch.md +++ b/build/docs/ReportingTurnKnowledgeSearch.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnKnowledgeSearchEvent.md b/build/docs/ReportingTurnKnowledgeSearchEvent.md index 55d39ad61..247cf4c3d 100644 --- a/build/docs/ReportingTurnKnowledgeSearchEvent.md +++ b/build/docs/ReportingTurnKnowledgeSearchEvent.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReportingTurnsResponse.md b/build/docs/ReportingTurnsResponse.md index 84f8f3161..56b0e2bb5 100644 --- a/build/docs/ReportingTurnsResponse.md +++ b/build/docs/ReportingTurnsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestConfig.md b/build/docs/RequestConfig.md index 0e4147201..ec03e11e8 100644 --- a/build/docs/RequestConfig.md +++ b/build/docs/RequestConfig.md @@ -15,4 +15,4 @@ Defines response components of the Action Request. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestContext.md b/build/docs/RequestContext.md index c754201d4..9cac5c08e 100644 --- a/build/docs/RequestContext.md +++ b/build/docs/RequestContext.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestContextPattern.md b/build/docs/RequestContextPattern.md index 634a31870..0d26fc744 100644 --- a/build/docs/RequestContextPattern.md +++ b/build/docs/RequestContextPattern.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestCriteria.md b/build/docs/RequestCriteria.md index 4d38f82fe..637c2cb14 100644 --- a/build/docs/RequestCriteria.md +++ b/build/docs/RequestCriteria.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestDevice.md b/build/docs/RequestDevice.md index 6b017fdc9..22aa28e82 100644 --- a/build/docs/RequestDevice.md +++ b/build/docs/RequestDevice.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestEntityTypeCriteria.md b/build/docs/RequestEntityTypeCriteria.md index 78dc05793..ec9ba3dcb 100644 --- a/build/docs/RequestEntityTypeCriteria.md +++ b/build/docs/RequestEntityTypeCriteria.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestExternalSegment.md b/build/docs/RequestExternalSegment.md index 3c87638ab..69f4d9c61 100644 --- a/build/docs/RequestExternalSegment.md +++ b/build/docs/RequestExternalSegment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestJourney.md b/build/docs/RequestJourney.md index 71914ea5d..7ba65729e 100644 --- a/build/docs/RequestJourney.md +++ b/build/docs/RequestJourney.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestJourneyPattern.md b/build/docs/RequestJourneyPattern.md index 6ca8a1e38..14eafcf10 100644 --- a/build/docs/RequestJourneyPattern.md +++ b/build/docs/RequestJourneyPattern.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestMapping.md b/build/docs/RequestMapping.md index 411045e1d..812c7cfeb 100644 --- a/build/docs/RequestMapping.md +++ b/build/docs/RequestMapping.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestPage.md b/build/docs/RequestPage.md index 56927b0eb..d54a9162a 100644 --- a/build/docs/RequestPage.md +++ b/build/docs/RequestPage.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequestScoredAgent.md b/build/docs/RequestScoredAgent.md index edda9b82a..408100bec 100644 --- a/build/docs/RequestScoredAgent.md +++ b/build/docs/RequestScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RequiredLocalDateRange.md b/build/docs/RequiredLocalDateRange.md index 075603fd3..acea564c3 100644 --- a/build/docs/RequiredLocalDateRange.md +++ b/build/docs/RequiredLocalDateRange.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReschedulingManagementUnitResponse.md b/build/docs/ReschedulingManagementUnitResponse.md index 80eb5c02e..1e8a5e1af 100644 --- a/build/docs/ReschedulingManagementUnitResponse.md +++ b/build/docs/ReschedulingManagementUnitResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReschedulingOptionsRunResponse.md b/build/docs/ReschedulingOptionsRunResponse.md index f9fc45793..3acc7e47d 100644 --- a/build/docs/ReschedulingOptionsRunResponse.md +++ b/build/docs/ReschedulingOptionsRunResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResolutionDetailQueryClause.md b/build/docs/ResolutionDetailQueryClause.md index 83b96923c..86d67718b 100644 --- a/build/docs/ResolutionDetailQueryClause.md +++ b/build/docs/ResolutionDetailQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResolutionDetailQueryFilter.md b/build/docs/ResolutionDetailQueryFilter.md index caf58f3b1..686f9fe50 100644 --- a/build/docs/ResolutionDetailQueryFilter.md +++ b/build/docs/ResolutionDetailQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResolutionDetailQueryPredicate.md b/build/docs/ResolutionDetailQueryPredicate.md index f04e72e11..2ba376a27 100644 --- a/build/docs/ResolutionDetailQueryPredicate.md +++ b/build/docs/ResolutionDetailQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResourceConditionNode.md b/build/docs/ResourceConditionNode.md index 094f5459f..bf13f7eb1 100644 --- a/build/docs/ResourceConditionNode.md +++ b/build/docs/ResourceConditionNode.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResourceConditionValue.md b/build/docs/ResourceConditionValue.md index a0249f7cd..78d893b8d 100644 --- a/build/docs/ResourceConditionValue.md +++ b/build/docs/ResourceConditionValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResourcePermissionPolicy.md b/build/docs/ResourcePermissionPolicy.md index f2d852fe4..c8e9ba9c4 100644 --- a/build/docs/ResourcePermissionPolicy.md +++ b/build/docs/ResourcePermissionPolicy.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Response.md b/build/docs/Response.md index ea1dc64a1..da1fd56fd 100644 --- a/build/docs/Response.md +++ b/build/docs/Response.md @@ -25,4 +25,4 @@ Contains information about a response. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseAsset.md b/build/docs/ResponseAsset.md index e08cada1b..f3490bb3a 100644 --- a/build/docs/ResponseAsset.md +++ b/build/docs/ResponseAsset.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseAssetFilter.md b/build/docs/ResponseAssetFilter.md index c453a7068..24db97fec 100644 --- a/build/docs/ResponseAssetFilter.md +++ b/build/docs/ResponseAssetFilter.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseAssetRequest.md b/build/docs/ResponseAssetRequest.md index 56f3dcb7c..ef76b06e5 100644 --- a/build/docs/ResponseAssetRequest.md +++ b/build/docs/ResponseAssetRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseAssetSearchRequest.md b/build/docs/ResponseAssetSearchRequest.md index 84ac66b49..8a5a536c4 100644 --- a/build/docs/ResponseAssetSearchRequest.md +++ b/build/docs/ResponseAssetSearchRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseAssetSearchResults.md b/build/docs/ResponseAssetSearchResults.md index 2ab7e38ff..aef7c5e30 100644 --- a/build/docs/ResponseAssetSearchResults.md +++ b/build/docs/ResponseAssetSearchResults.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseAssetStatus.md b/build/docs/ResponseAssetStatus.md index 95244b809..9ba327d3b 100644 --- a/build/docs/ResponseAssetStatus.md +++ b/build/docs/ResponseAssetStatus.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseConfig.md b/build/docs/ResponseConfig.md index e83484496..6bfa9e4a9 100644 --- a/build/docs/ResponseConfig.md +++ b/build/docs/ResponseConfig.md @@ -14,4 +14,4 @@ Defines response components of the Action Request. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseEntityList.md b/build/docs/ResponseEntityList.md index d719dd80e..787af33a0 100644 --- a/build/docs/ResponseEntityList.md +++ b/build/docs/ResponseEntityList.md @@ -11,13 +11,13 @@ Query result list | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseEntityListing.md b/build/docs/ResponseEntityListing.md index 5d7c7deaf..acc81742c 100644 --- a/build/docs/ResponseEntityListing.md +++ b/build/docs/ResponseEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseFilter.md b/build/docs/ResponseFilter.md index 0e742140a..6cb263f43 100644 --- a/build/docs/ResponseFilter.md +++ b/build/docs/ResponseFilter.md @@ -13,4 +13,4 @@ Used to filter response queries -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseManagementAPI.md b/build/docs/ResponseManagementAPI.md index f3ce324ff..cc5164718 100644 --- a/build/docs/ResponseManagementAPI.md +++ b/build/docs/ResponseManagementAPI.md @@ -956,4 +956,4 @@ ResponseManagementAPI.putResponsemanagementResponseasset(responseAssetId: respon [**ResponseAsset**](ResponseAsset) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponsePage.md b/build/docs/ResponsePage.md index 82e4460bf..8c0d35a08 100644 --- a/build/docs/ResponsePage.md +++ b/build/docs/ResponsePage.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseQueryRequest.md b/build/docs/ResponseQueryRequest.md index 036d45940..02e55a596 100644 --- a/build/docs/ResponseQueryRequest.md +++ b/build/docs/ResponseQueryRequest.md @@ -14,4 +14,4 @@ Used to query for responses -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseQueryResults.md b/build/docs/ResponseQueryResults.md index a22b5dbef..4c5ad1a42 100644 --- a/build/docs/ResponseQueryResults.md +++ b/build/docs/ResponseQueryResults.md @@ -11,4 +11,4 @@ Used to return response query results -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseSet.md b/build/docs/ResponseSet.md index f28c1f205..d9fe66cf9 100644 --- a/build/docs/ResponseSet.md +++ b/build/docs/ResponseSet.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseSetEntityListing.md b/build/docs/ResponseSetEntityListing.md index 13aa58d09..bf115cea5 100644 --- a/build/docs/ResponseSetEntityListing.md +++ b/build/docs/ResponseSetEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseSubstitution.md b/build/docs/ResponseSubstitution.md index c5712b0cb..95275ea7f 100644 --- a/build/docs/ResponseSubstitution.md +++ b/build/docs/ResponseSubstitution.md @@ -13,4 +13,4 @@ Contains information about the substitutions associated with a response. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResponseText.md b/build/docs/ResponseText.md index 67f6382ea..a43d47336 100644 --- a/build/docs/ResponseText.md +++ b/build/docs/ResponseText.md @@ -13,4 +13,4 @@ Contains information about the text associated with a response. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RestErrorDetail.md b/build/docs/RestErrorDetail.md index 1fd618147..06f82bfaa 100644 --- a/build/docs/RestErrorDetail.md +++ b/build/docs/RestErrorDetail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RestorePresenceSettings.md b/build/docs/RestorePresenceSettings.md index 5dc1fbb15..8d5b48188 100644 --- a/build/docs/RestorePresenceSettings.md +++ b/build/docs/RestorePresenceSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ResultCounters.md b/build/docs/ResultCounters.md index 4cf27de6e..681e9e732 100644 --- a/build/docs/ResultCounters.md +++ b/build/docs/ResultCounters.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RetentionDuration.md b/build/docs/RetentionDuration.md index 0c8ff2d31..9f0716cb0 100644 --- a/build/docs/RetentionDuration.md +++ b/build/docs/RetentionDuration.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReverseWhitepagesLookupResult.md b/build/docs/ReverseWhitepagesLookupResult.md index 62138c07a..93bf8cd03 100644 --- a/build/docs/ReverseWhitepagesLookupResult.md +++ b/build/docs/ReverseWhitepagesLookupResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ReviewAssessmentResults.md b/build/docs/ReviewAssessmentResults.md index 7763b17ab..5c36a579e 100644 --- a/build/docs/ReviewAssessmentResults.md +++ b/build/docs/ReviewAssessmentResults.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Ring.md b/build/docs/Ring.md index 0ee518476..6a26b7f50 100644 --- a/build/docs/Ring.md +++ b/build/docs/Ring.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoleDivision.md b/build/docs/RoleDivision.md index 1b482e21e..5412f33ee 100644 --- a/build/docs/RoleDivision.md +++ b/build/docs/RoleDivision.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoleDivisionGrants.md b/build/docs/RoleDivisionGrants.md index 2d9705c62..acf050dec 100644 --- a/build/docs/RoleDivisionGrants.md +++ b/build/docs/RoleDivisionGrants.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoleDivisionPair.md b/build/docs/RoleDivisionPair.md index 72cb06c63..09fd5b185 100644 --- a/build/docs/RoleDivisionPair.md +++ b/build/docs/RoleDivisionPair.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoleSettings.md b/build/docs/RoleSettings.md index 1c33bcd5b..b90999c4a 100644 --- a/build/docs/RoleSettings.md +++ b/build/docs/RoleSettings.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Room.md b/build/docs/Room.md index e02f74a3e..5f64de18c 100644 --- a/build/docs/Room.md +++ b/build/docs/Room.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoomParticipant.md b/build/docs/RoomParticipant.md index 6f169b13b..663442327 100644 --- a/build/docs/RoomParticipant.md +++ b/build/docs/RoomParticipant.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoomParticipantResponse.md b/build/docs/RoomParticipantResponse.md index 6aff15933..d8d6ba98f 100644 --- a/build/docs/RoomParticipantResponse.md +++ b/build/docs/RoomParticipantResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoomParticipantsResponse.md b/build/docs/RoomParticipantsResponse.md index e64c2ed9e..308e82cdf 100644 --- a/build/docs/RoomParticipantsResponse.md +++ b/build/docs/RoomParticipantsResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoomUpdateRequest.md b/build/docs/RoomUpdateRequest.md index e7ab92c6b..378addf8f 100644 --- a/build/docs/RoomUpdateRequest.md +++ b/build/docs/RoomUpdateRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutePathRequest.md b/build/docs/RoutePathRequest.md index bb224ee97..475ed3b50 100644 --- a/build/docs/RoutePathRequest.md +++ b/build/docs/RoutePathRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutePathResponse.md b/build/docs/RoutePathResponse.md index c93a50f7b..41b81f8fb 100644 --- a/build/docs/RoutePathResponse.md +++ b/build/docs/RoutePathResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingAPI.md b/build/docs/RoutingAPI.md index 052b9f2bb..027877620 100644 --- a/build/docs/RoutingAPI.md +++ b/build/docs/RoutingAPI.md @@ -7670,4 +7670,4 @@ RoutingAPI.putUserRoutingskillsBulk(userId: userId, body: body) { (response, err [**UserSkillEntityListing**](UserSkillEntityListing) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityData.md b/build/docs/RoutingActivityData.md index b82c2bfde..a99e28b51 100644 --- a/build/docs/RoutingActivityData.md +++ b/build/docs/RoutingActivityData.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityEntityData.md b/build/docs/RoutingActivityEntityData.md index e51a66db5..e4ad7402c 100644 --- a/build/docs/RoutingActivityEntityData.md +++ b/build/docs/RoutingActivityEntityData.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityMetricValue.md b/build/docs/RoutingActivityMetricValue.md index 6697fcf3d..64cfba576 100644 --- a/build/docs/RoutingActivityMetricValue.md +++ b/build/docs/RoutingActivityMetricValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityQuery.md b/build/docs/RoutingActivityQuery.md index 2898838da..fa54ec5c3 100644 --- a/build/docs/RoutingActivityQuery.md +++ b/build/docs/RoutingActivityQuery.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityQueryClause.md b/build/docs/RoutingActivityQueryClause.md index 7339c25c4..e184ef30c 100644 --- a/build/docs/RoutingActivityQueryClause.md +++ b/build/docs/RoutingActivityQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityQueryFilter.md b/build/docs/RoutingActivityQueryFilter.md index cc8bcde37..439fba33c 100644 --- a/build/docs/RoutingActivityQueryFilter.md +++ b/build/docs/RoutingActivityQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityQueryMetric.md b/build/docs/RoutingActivityQueryMetric.md index 8ecb0daba..cb3b349c0 100644 --- a/build/docs/RoutingActivityQueryMetric.md +++ b/build/docs/RoutingActivityQueryMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityQueryPredicate.md b/build/docs/RoutingActivityQueryPredicate.md index 1ec2b0e9c..3aada0d70 100644 --- a/build/docs/RoutingActivityQueryPredicate.md +++ b/build/docs/RoutingActivityQueryPredicate.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingActivityResponse.md b/build/docs/RoutingActivityResponse.md index 5021e9f9d..dcf7c202e 100644 --- a/build/docs/RoutingActivityResponse.md +++ b/build/docs/RoutingActivityResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingConversationAttributesRequest.md b/build/docs/RoutingConversationAttributesRequest.md index 18bfe4aa3..82e7b0225 100644 --- a/build/docs/RoutingConversationAttributesRequest.md +++ b/build/docs/RoutingConversationAttributesRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingConversationAttributesResponse.md b/build/docs/RoutingConversationAttributesResponse.md index 0859e5b25..afecf52fd 100644 --- a/build/docs/RoutingConversationAttributesResponse.md +++ b/build/docs/RoutingConversationAttributesResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingData.md b/build/docs/RoutingData.md index fb245e245..ce08d04f4 100644 --- a/build/docs/RoutingData.md +++ b/build/docs/RoutingData.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingEstablishedEvent.md b/build/docs/RoutingEstablishedEvent.md index e198ab92e..6ab84bc9d 100644 --- a/build/docs/RoutingEstablishedEvent.md +++ b/build/docs/RoutingEstablishedEvent.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingRule.md b/build/docs/RoutingRule.md index 4e880eaf2..50ad18b08 100644 --- a/build/docs/RoutingRule.md +++ b/build/docs/RoutingRule.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingSettings.md b/build/docs/RoutingSettings.md index 08112c2c3..0580458f9 100644 --- a/build/docs/RoutingSettings.md +++ b/build/docs/RoutingSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingSkill.md b/build/docs/RoutingSkill.md index 117be4d5b..bb3b13e0d 100644 --- a/build/docs/RoutingSkill.md +++ b/build/docs/RoutingSkill.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingSkillReference.md b/build/docs/RoutingSkillReference.md index 380c0895a..a6d7685bc 100644 --- a/build/docs/RoutingSkillReference.md +++ b/build/docs/RoutingSkillReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingStatus.md b/build/docs/RoutingStatus.md index 5926cea3a..16369d151 100644 --- a/build/docs/RoutingStatus.md +++ b/build/docs/RoutingStatus.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingStatusDetailQueryClause.md b/build/docs/RoutingStatusDetailQueryClause.md index 613deab11..bd5218cec 100644 --- a/build/docs/RoutingStatusDetailQueryClause.md +++ b/build/docs/RoutingStatusDetailQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingStatusDetailQueryFilter.md b/build/docs/RoutingStatusDetailQueryFilter.md index dfed6ce29..efdeb5a87 100644 --- a/build/docs/RoutingStatusDetailQueryFilter.md +++ b/build/docs/RoutingStatusDetailQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingStatusDetailQueryPredicate.md b/build/docs/RoutingStatusDetailQueryPredicate.md index 535366b4f..e9a90b45e 100644 --- a/build/docs/RoutingStatusDetailQueryPredicate.md +++ b/build/docs/RoutingStatusDetailQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RoutingTransferEvent.md b/build/docs/RoutingTransferEvent.md index 39242d79e..4bd5baaf0 100644 --- a/build/docs/RoutingTransferEvent.md +++ b/build/docs/RoutingTransferEvent.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RuleConfig.md b/build/docs/RuleConfig.md index 3b2e4e3b4..204f4509f 100644 --- a/build/docs/RuleConfig.md +++ b/build/docs/RuleConfig.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RuleEngineConfig.md b/build/docs/RuleEngineConfig.md index dc2cf3cda..407e97041 100644 --- a/build/docs/RuleEngineConfig.md +++ b/build/docs/RuleEngineConfig.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RuleSet.md b/build/docs/RuleSet.md index e6c81cfb6..3b9e3bf86 100644 --- a/build/docs/RuleSet.md +++ b/build/docs/RuleSet.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RuleSetDiagnostic.md b/build/docs/RuleSetDiagnostic.md index 1c25d7709..e45a43cbb 100644 --- a/build/docs/RuleSetDiagnostic.md +++ b/build/docs/RuleSetDiagnostic.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/RuleSetEntityListing.md b/build/docs/RuleSetEntityListing.md index 43cb13d92..74dd3750a 100644 --- a/build/docs/RuleSetEntityListing.md +++ b/build/docs/RuleSetEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SCIMAPI.md b/build/docs/SCIMAPI.md index f2b4ee496..98847a643 100644 --- a/build/docs/SCIMAPI.md +++ b/build/docs/SCIMAPI.md @@ -1645,4 +1645,4 @@ SCIMAPI.putScimV2User(userId: userId, body: body, ifMatch: ifMatch) { (response, [**ScimV2User**](ScimV2User) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SIPSearchPublicRequest.md b/build/docs/SIPSearchPublicRequest.md index ebfd2c1ac..a9cfe1155 100644 --- a/build/docs/SIPSearchPublicRequest.md +++ b/build/docs/SIPSearchPublicRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SMSAvailablePhoneNumberEntityListing.md b/build/docs/SMSAvailablePhoneNumberEntityListing.md index 033a748f7..0ee07364c 100644 --- a/build/docs/SMSAvailablePhoneNumberEntityListing.md +++ b/build/docs/SMSAvailablePhoneNumberEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Salesforce.md b/build/docs/Salesforce.md index 542857b2a..3de7dfd40 100644 --- a/build/docs/Salesforce.md +++ b/build/docs/Salesforce.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SalesforceSettings.md b/build/docs/SalesforceSettings.md index 19b2c3c79..b3b30da4d 100644 --- a/build/docs/SalesforceSettings.md +++ b/build/docs/SalesforceSettings.md @@ -9,7 +9,8 @@ | **channel** | **String** | Filter source by channel. | [optional] | | **language** | **String** | Filter source by language. | [optional] | | **categories** | **[String]** | Filter source by categories. | [optional] | +| **baseUrl** | **String** | The base URL to resources. | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SalesforceSourceRequest.md b/build/docs/SalesforceSourceRequest.md index ba85cf47d..6e311de2f 100644 --- a/build/docs/SalesforceSourceRequest.md +++ b/build/docs/SalesforceSourceRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SalesforceSourceResponse.md b/build/docs/SalesforceSourceResponse.md index cacca1562..75e48c50b 100644 --- a/build/docs/SalesforceSourceResponse.md +++ b/build/docs/SalesforceSourceResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Schedule.md b/build/docs/Schedule.md index f51889a55..2e941e9b4 100644 --- a/build/docs/Schedule.md +++ b/build/docs/Schedule.md @@ -26,4 +26,4 @@ Defines a period of time to perform a specific action. Each schedule must be as -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleActivity.md b/build/docs/ScheduleActivity.md index d157a96f6..c0136806e 100644 --- a/build/docs/ScheduleActivity.md +++ b/build/docs/ScheduleActivity.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleDivisionViewEntityListing.md b/build/docs/ScheduleDivisionViewEntityListing.md index 57c68ff7b..21ba4f3b2 100644 --- a/build/docs/ScheduleDivisionViewEntityListing.md +++ b/build/docs/ScheduleDivisionViewEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleEntityListing.md b/build/docs/ScheduleEntityListing.md index 787e44d1c..5e56d906c 100644 --- a/build/docs/ScheduleEntityListing.md +++ b/build/docs/ScheduleEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleGenerationMessage.md b/build/docs/ScheduleGenerationMessage.md index 9ee0bbae2..1c1f3932d 100644 --- a/build/docs/ScheduleGenerationMessage.md +++ b/build/docs/ScheduleGenerationMessage.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleGenerationResult.md b/build/docs/ScheduleGenerationResult.md index afb403d29..3a9e2fbeb 100644 --- a/build/docs/ScheduleGenerationResult.md +++ b/build/docs/ScheduleGenerationResult.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleGenerationResultSummary.md b/build/docs/ScheduleGenerationResultSummary.md index 7993aa914..090315ad7 100644 --- a/build/docs/ScheduleGenerationResultSummary.md +++ b/build/docs/ScheduleGenerationResultSummary.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleGenerationWarning.md b/build/docs/ScheduleGenerationWarning.md index 670d345bd..5bc8fc0b4 100644 --- a/build/docs/ScheduleGenerationWarning.md +++ b/build/docs/ScheduleGenerationWarning.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleGroup.md b/build/docs/ScheduleGroup.md index 77bde3aad..8c5550448 100644 --- a/build/docs/ScheduleGroup.md +++ b/build/docs/ScheduleGroup.md @@ -27,4 +27,4 @@ A group of schedules that define the operating hours of an organization. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleGroupDivisionView.md b/build/docs/ScheduleGroupDivisionView.md index 42853e955..cf0e186f1 100644 --- a/build/docs/ScheduleGroupDivisionView.md +++ b/build/docs/ScheduleGroupDivisionView.md @@ -14,4 +14,4 @@ A schedule group. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleGroupDivisionViewEntityListing.md b/build/docs/ScheduleGroupDivisionViewEntityListing.md index 2f89c1ecc..a7c0e99b1 100644 --- a/build/docs/ScheduleGroupDivisionViewEntityListing.md +++ b/build/docs/ScheduleGroupDivisionViewEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleGroupEntityListing.md b/build/docs/ScheduleGroupEntityListing.md index fc2e9cd47..bd83c17a0 100644 --- a/build/docs/ScheduleGroupEntityListing.md +++ b/build/docs/ScheduleGroupEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleInterval.md b/build/docs/ScheduleInterval.md index 9306c8fbd..aa9b68422 100644 --- a/build/docs/ScheduleInterval.md +++ b/build/docs/ScheduleInterval.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScheduleUploadProcessingResponse.md b/build/docs/ScheduleUploadProcessingResponse.md index 3988b09d5..2edf64a6f 100644 --- a/build/docs/ScheduleUploadProcessingResponse.md +++ b/build/docs/ScheduleUploadProcessingResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulerMessageArgument.md b/build/docs/SchedulerMessageArgument.md index b45a71175..55bf1ee2e 100644 --- a/build/docs/SchedulerMessageArgument.md +++ b/build/docs/SchedulerMessageArgument.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulerMessageSeverityCount.md b/build/docs/SchedulerMessageSeverityCount.md index 8d5036999..d829cdbe1 100644 --- a/build/docs/SchedulerMessageSeverityCount.md +++ b/build/docs/SchedulerMessageSeverityCount.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulerMessageTypeSeverity.md b/build/docs/SchedulerMessageTypeSeverity.md index 7fe217a8e..4388b7721 100644 --- a/build/docs/SchedulerMessageTypeSeverity.md +++ b/build/docs/SchedulerMessageTypeSeverity.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulesDivisionView.md b/build/docs/SchedulesDivisionView.md index c994e2e5f..2a548f8fa 100644 --- a/build/docs/SchedulesDivisionView.md +++ b/build/docs/SchedulesDivisionView.md @@ -14,4 +14,4 @@ A schedule. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulingNoForecastOptionsRequest.md b/build/docs/SchedulingNoForecastOptionsRequest.md index 2cc0f35fc..345a558a8 100644 --- a/build/docs/SchedulingNoForecastOptionsRequest.md +++ b/build/docs/SchedulingNoForecastOptionsRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulingOptionsRequest.md b/build/docs/SchedulingOptionsRequest.md index b6bc47b1b..ce9ba1705 100644 --- a/build/docs/SchedulingOptionsRequest.md +++ b/build/docs/SchedulingOptionsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulingPeriod.md b/build/docs/SchedulingPeriod.md index 49bc1e98f..ce12d3ff8 100644 --- a/build/docs/SchedulingPeriod.md +++ b/build/docs/SchedulingPeriod.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulingProcessingError.md b/build/docs/SchedulingProcessingError.md index b89fae62c..95b9359c4 100644 --- a/build/docs/SchedulingProcessingError.md +++ b/build/docs/SchedulingProcessingError.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulingSettingsRequest.md b/build/docs/SchedulingSettingsRequest.md index 194d257df..9315f62b7 100644 --- a/build/docs/SchedulingSettingsRequest.md +++ b/build/docs/SchedulingSettingsRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulingSettingsResponse.md b/build/docs/SchedulingSettingsResponse.md index 9084ee950..b59675ad5 100644 --- a/build/docs/SchedulingSettingsResponse.md +++ b/build/docs/SchedulingSettingsResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulingStatusResponse.md b/build/docs/SchedulingStatusResponse.md index 2204f96de..2dd9c9ef1 100644 --- a/build/docs/SchedulingStatusResponse.md +++ b/build/docs/SchedulingStatusResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchedulingTestingOptionsRequest.md b/build/docs/SchedulingTestingOptionsRequest.md index eb5939a25..c2d8c3ced 100644 --- a/build/docs/SchedulingTestingOptionsRequest.md +++ b/build/docs/SchedulingTestingOptionsRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Schema.md b/build/docs/Schema.md index 22a042659..d70dab4f5 100644 --- a/build/docs/Schema.md +++ b/build/docs/Schema.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SchemaQuantityLimits.md b/build/docs/SchemaQuantityLimits.md index 7845c43e6..e218a6f86 100644 --- a/build/docs/SchemaQuantityLimits.md +++ b/build/docs/SchemaQuantityLimits.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimConfigResourceType.md b/build/docs/ScimConfigResourceType.md index 744ada1ef..bc153ce68 100644 --- a/build/docs/ScimConfigResourceType.md +++ b/build/docs/ScimConfigResourceType.md @@ -18,4 +18,4 @@ Defines a SCIM resource. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimConfigResourceTypeSchemaExtension.md b/build/docs/ScimConfigResourceTypeSchemaExtension.md index 57f8b9013..150bf47f6 100644 --- a/build/docs/ScimConfigResourceTypeSchemaExtension.md +++ b/build/docs/ScimConfigResourceTypeSchemaExtension.md @@ -12,4 +12,4 @@ Defines a SCIM resource type's schema extension. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimConfigResourceTypesListResponse.md b/build/docs/ScimConfigResourceTypesListResponse.md index feca556be..407408dd8 100644 --- a/build/docs/ScimConfigResourceTypesListResponse.md +++ b/build/docs/ScimConfigResourceTypesListResponse.md @@ -15,4 +15,4 @@ Defines a response for a list of SCIM resource types. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimEmail.md b/build/docs/ScimEmail.md index 02e41ecd0..0e59202a9 100644 --- a/build/docs/ScimEmail.md +++ b/build/docs/ScimEmail.md @@ -13,4 +13,4 @@ Defines a SCIM email address. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimError.md b/build/docs/ScimError.md index c9713bc11..8261cc623 100644 --- a/build/docs/ScimError.md +++ b/build/docs/ScimError.md @@ -14,4 +14,4 @@ Defines a SCIM error. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimGenesysUserExternalId.md b/build/docs/ScimGenesysUserExternalId.md index 3790f02c1..ab8892150 100644 --- a/build/docs/ScimGenesysUserExternalId.md +++ b/build/docs/ScimGenesysUserExternalId.md @@ -12,4 +12,4 @@ External Identifiers of user. The external identifier must be unique within the -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimGroupListResponse.md b/build/docs/ScimGroupListResponse.md index f5e1dbeed..d0dd6641f 100644 --- a/build/docs/ScimGroupListResponse.md +++ b/build/docs/ScimGroupListResponse.md @@ -15,4 +15,4 @@ Defines a response for a list of SCIM groups. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimMetadata.md b/build/docs/ScimMetadata.md index 7a170576c..160c24275 100644 --- a/build/docs/ScimMetadata.md +++ b/build/docs/ScimMetadata.md @@ -14,4 +14,4 @@ Defines the SCIM metadata. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimPhoneNumber.md b/build/docs/ScimPhoneNumber.md index a412b6ec5..256937a4c 100644 --- a/build/docs/ScimPhoneNumber.md +++ b/build/docs/ScimPhoneNumber.md @@ -13,4 +13,4 @@ Defines a SCIM phone number. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimServiceProviderConfig.md b/build/docs/ScimServiceProviderConfig.md index a81e52063..2802ca2ff 100644 --- a/build/docs/ScimServiceProviderConfig.md +++ b/build/docs/ScimServiceProviderConfig.md @@ -20,4 +20,4 @@ Defines a SCIM service provider's configuration. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimServiceProviderConfigAuthenticationScheme.md b/build/docs/ScimServiceProviderConfigAuthenticationScheme.md index 825a135b6..078990ebb 100644 --- a/build/docs/ScimServiceProviderConfigAuthenticationScheme.md +++ b/build/docs/ScimServiceProviderConfigAuthenticationScheme.md @@ -16,4 +16,4 @@ Defines an authentication scheme in the SCIM service provider's configuratio -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimServiceProviderConfigBulkFeature.md b/build/docs/ScimServiceProviderConfigBulkFeature.md index 0fa6e694c..9d43c556a 100644 --- a/build/docs/ScimServiceProviderConfigBulkFeature.md +++ b/build/docs/ScimServiceProviderConfigBulkFeature.md @@ -13,4 +13,4 @@ Defines a \"bulk\" request in the SCIM service provider's configur -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimServiceProviderConfigFilterFeature.md b/build/docs/ScimServiceProviderConfigFilterFeature.md index e84622a88..0a8d954d7 100644 --- a/build/docs/ScimServiceProviderConfigFilterFeature.md +++ b/build/docs/ScimServiceProviderConfigFilterFeature.md @@ -12,4 +12,4 @@ Defines a \"filter\" request in the SCIM service provider's config -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimServiceProviderConfigSimpleFeature.md b/build/docs/ScimServiceProviderConfigSimpleFeature.md index 04f8c1a47..2a10c7050 100644 --- a/build/docs/ScimServiceProviderConfigSimpleFeature.md +++ b/build/docs/ScimServiceProviderConfigSimpleFeature.md @@ -11,4 +11,4 @@ Defines a request in the SCIM service provider's configuration. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimUserExtensions.md b/build/docs/ScimUserExtensions.md index ab2d7280a..a2656bc45 100644 --- a/build/docs/ScimUserExtensions.md +++ b/build/docs/ScimUserExtensions.md @@ -13,4 +13,4 @@ Genesys Cloud user extensions to SCIM RFC. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimUserListResponse.md b/build/docs/ScimUserListResponse.md index c7a4ac0e4..0d5aa0ffa 100644 --- a/build/docs/ScimUserListResponse.md +++ b/build/docs/ScimUserListResponse.md @@ -15,4 +15,4 @@ Defines a response for a list of SCIM users. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimUserRole.md b/build/docs/ScimUserRole.md index 11bee7ca2..e6c523a37 100644 --- a/build/docs/ScimUserRole.md +++ b/build/docs/ScimUserRole.md @@ -11,4 +11,4 @@ Defines a user role. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimUserRoutingLanguage.md b/build/docs/ScimUserRoutingLanguage.md index a3304349f..64e8d9cda 100644 --- a/build/docs/ScimUserRoutingLanguage.md +++ b/build/docs/ScimUserRoutingLanguage.md @@ -12,4 +12,4 @@ The routing language assigned to a user. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimUserRoutingSkill.md b/build/docs/ScimUserRoutingSkill.md index 529e7d388..59c2464b1 100644 --- a/build/docs/ScimUserRoutingSkill.md +++ b/build/docs/ScimUserRoutingSkill.md @@ -12,4 +12,4 @@ The routing skill assigned to a user. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2CreateUser.md b/build/docs/ScimV2CreateUser.md index 353b65327..1daa92f60 100644 --- a/build/docs/ScimV2CreateUser.md +++ b/build/docs/ScimV2CreateUser.md @@ -23,4 +23,4 @@ Defines the creation of a SCIM user. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2EnterpriseUser.md b/build/docs/ScimV2EnterpriseUser.md index 6fca9fcf2..f6fdf9811 100644 --- a/build/docs/ScimV2EnterpriseUser.md +++ b/build/docs/ScimV2EnterpriseUser.md @@ -15,4 +15,4 @@ Defines a SCIM enterprise user. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2Group.md b/build/docs/ScimV2Group.md index 53c4f9ed1..9b33bf3b8 100644 --- a/build/docs/ScimV2Group.md +++ b/build/docs/ScimV2Group.md @@ -16,4 +16,4 @@ Defines a SCIM group. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2GroupReference.md b/build/docs/ScimV2GroupReference.md index 3013152af..6aabfdc75 100644 --- a/build/docs/ScimV2GroupReference.md +++ b/build/docs/ScimV2GroupReference.md @@ -13,4 +13,4 @@ Defines a reference to SCIM groups. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2MemberReference.md b/build/docs/ScimV2MemberReference.md index a65067e92..567194218 100644 --- a/build/docs/ScimV2MemberReference.md +++ b/build/docs/ScimV2MemberReference.md @@ -13,4 +13,4 @@ Defines a reference to SCIM group members. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2PatchOperation.md b/build/docs/ScimV2PatchOperation.md index 427bcf716..d77953e9f 100644 --- a/build/docs/ScimV2PatchOperation.md +++ b/build/docs/ScimV2PatchOperation.md @@ -13,4 +13,4 @@ Defines a SCIM PATCH operation. The path and value follow very specific rules ba -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2PatchRequest.md b/build/docs/ScimV2PatchRequest.md index 742984100..f62106e6e 100644 --- a/build/docs/ScimV2PatchRequest.md +++ b/build/docs/ScimV2PatchRequest.md @@ -12,4 +12,4 @@ Defines a SCIM PATCH request. See section 3.5.2 \"Modifying with PATCH\&quo -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2SchemaAttribute.md b/build/docs/ScimV2SchemaAttribute.md index 5e71ae5ed..ef8bd2f7c 100644 --- a/build/docs/ScimV2SchemaAttribute.md +++ b/build/docs/ScimV2SchemaAttribute.md @@ -22,4 +22,4 @@ A complex type that defines service provider attributes or subattributes and the -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2SchemaDefinition.md b/build/docs/ScimV2SchemaDefinition.md index 9a96d1c98..d09172a37 100644 --- a/build/docs/ScimV2SchemaDefinition.md +++ b/build/docs/ScimV2SchemaDefinition.md @@ -15,4 +15,4 @@ Defines a SCIM schema. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2SchemaListResponse.md b/build/docs/ScimV2SchemaListResponse.md index 0d6d7938e..980de1948 100644 --- a/build/docs/ScimV2SchemaListResponse.md +++ b/build/docs/ScimV2SchemaListResponse.md @@ -15,4 +15,4 @@ Defines the list response for SCIM resource types. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScimV2User.md b/build/docs/ScimV2User.md index 4a037c76f..f5ee93925 100644 --- a/build/docs/ScimV2User.md +++ b/build/docs/ScimV2User.md @@ -25,4 +25,4 @@ Defines a SCIM user. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScorableSurvey.md b/build/docs/ScorableSurvey.md index c934f2248..99806b53f 100644 --- a/build/docs/ScorableSurvey.md +++ b/build/docs/ScorableSurvey.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScoredAgent.md b/build/docs/ScoredAgent.md index 091f9dfc4..92f576dd0 100644 --- a/build/docs/ScoredAgent.md +++ b/build/docs/ScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScreenRecordingAPI.md b/build/docs/ScreenRecordingAPI.md index 4a6157f00..9f53171a8 100644 --- a/build/docs/ScreenRecordingAPI.md +++ b/build/docs/ScreenRecordingAPI.md @@ -57,4 +57,4 @@ ScreenRecordingAPI.postScreenrecordingToken(body: body) { (response, error) in [**SignedData**](SignedData) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScreenRecordingActiveSessions.md b/build/docs/ScreenRecordingActiveSessions.md index 1f6c4f9c8..78b9d40a2 100644 --- a/build/docs/ScreenRecordingActiveSessions.md +++ b/build/docs/ScreenRecordingActiveSessions.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScreenRecordingMetaData.md b/build/docs/ScreenRecordingMetaData.md index 4652294f9..38f59d3d6 100644 --- a/build/docs/ScreenRecordingMetaData.md +++ b/build/docs/ScreenRecordingMetaData.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScreenRecordingMetaDataRequest.md b/build/docs/ScreenRecordingMetaDataRequest.md index e6b134a05..58aa335f9 100644 --- a/build/docs/ScreenRecordingMetaDataRequest.md +++ b/build/docs/ScreenRecordingMetaDataRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScreenRecordingSession.md b/build/docs/ScreenRecordingSession.md index e01bca6e7..a78631320 100644 --- a/build/docs/ScreenRecordingSession.md +++ b/build/docs/ScreenRecordingSession.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScreenRecordingSessionListing.md b/build/docs/ScreenRecordingSessionListing.md index a99c3688d..edb5c61b9 100644 --- a/build/docs/ScreenRecordingSessionListing.md +++ b/build/docs/ScreenRecordingSessionListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScreenRecordingSessionRequest.md b/build/docs/ScreenRecordingSessionRequest.md index e2973bc3d..609140f8f 100644 --- a/build/docs/ScreenRecordingSessionRequest.md +++ b/build/docs/ScreenRecordingSessionRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScreenRecordingUserAuthenticatedInfo.md b/build/docs/ScreenRecordingUserAuthenticatedInfo.md index 4dac83b03..79bb799ca 100644 --- a/build/docs/ScreenRecordingUserAuthenticatedInfo.md +++ b/build/docs/ScreenRecordingUserAuthenticatedInfo.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Screenshare.md b/build/docs/Screenshare.md index e76d27d83..251ce3d66 100644 --- a/build/docs/Screenshare.md +++ b/build/docs/Screenshare.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Script.md b/build/docs/Script.md index b62bdf77f..c349ea946 100644 --- a/build/docs/Script.md +++ b/build/docs/Script.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScriptEntityListing.md b/build/docs/ScriptEntityListing.md index a62209fa9..85b620708 100644 --- a/build/docs/ScriptEntityListing.md +++ b/build/docs/ScriptEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScriptsAPI.md b/build/docs/ScriptsAPI.md index 3189b504f..c64e9f823 100644 --- a/build/docs/ScriptsAPI.md +++ b/build/docs/ScriptsAPI.md @@ -813,4 +813,4 @@ ScriptsAPI.postScriptsPublished(scriptDataVersion: scriptDataVersion, body: body [**Script**](Script) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ScrollPercentageEventTrigger.md b/build/docs/ScrollPercentageEventTrigger.md index ab4cbb4f4..7eb48b0e2 100644 --- a/build/docs/ScrollPercentageEventTrigger.md +++ b/build/docs/ScrollPercentageEventTrigger.md @@ -12,4 +12,4 @@ Details about a scroll percentage event trigger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SdkLibrary.md b/build/docs/SdkLibrary.md index 7671c433d..1b35d4453 100644 --- a/build/docs/SdkLibrary.md +++ b/build/docs/SdkLibrary.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchAPI.md b/build/docs/SearchAPI.md index 9c9697030..09a4b30e6 100644 --- a/build/docs/SearchAPI.md +++ b/build/docs/SearchAPI.md @@ -1250,4 +1250,4 @@ SearchAPI.postVoicemailSearch(body: body) { (response, error) in [**VoicemailsSearchResponse**](VoicemailsSearchResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchAggregation.md b/build/docs/SearchAggregation.md index a731bc8ca..5fa150ecf 100644 --- a/build/docs/SearchAggregation.md +++ b/build/docs/SearchAggregation.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchAlternativeShiftTradesRequest.md b/build/docs/SearchAlternativeShiftTradesRequest.md index 91e889eea..7266fbe98 100644 --- a/build/docs/SearchAlternativeShiftTradesRequest.md +++ b/build/docs/SearchAlternativeShiftTradesRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchCriteria.md b/build/docs/SearchCriteria.md index 609a646ce..a1d2dd2b7 100644 --- a/build/docs/SearchCriteria.md +++ b/build/docs/SearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchRequest.md b/build/docs/SearchRequest.md index 2e655219d..5cea100c7 100644 --- a/build/docs/SearchRequest.md +++ b/build/docs/SearchRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchShiftTradeResponse.md b/build/docs/SearchShiftTradeResponse.md index e7c542712..6d7ed8b00 100644 --- a/build/docs/SearchShiftTradeResponse.md +++ b/build/docs/SearchShiftTradeResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchShiftTradesRequest.md b/build/docs/SearchShiftTradesRequest.md index cf5bc2716..d6ebe8d1b 100644 --- a/build/docs/SearchShiftTradesRequest.md +++ b/build/docs/SearchShiftTradesRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchShiftTradesResponse.md b/build/docs/SearchShiftTradesResponse.md index 47ac6b4d3..006fb6f40 100644 --- a/build/docs/SearchShiftTradesResponse.md +++ b/build/docs/SearchShiftTradesResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchSort.md b/build/docs/SearchSort.md index d2c5d1e1d..791936ab7 100644 --- a/build/docs/SearchSort.md +++ b/build/docs/SearchSort.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SearchUpdateRequest.md b/build/docs/SearchUpdateRequest.md index ab1570740..af7d1e5f8 100644 --- a/build/docs/SearchUpdateRequest.md +++ b/build/docs/SearchUpdateRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SecondaryPresence.md b/build/docs/SecondaryPresence.md index d66f91c61..71c49a666 100644 --- a/build/docs/SecondaryPresence.md +++ b/build/docs/SecondaryPresence.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Section.md b/build/docs/Section.md index ad518251c..151327510 100644 --- a/build/docs/Section.md +++ b/build/docs/Section.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SecureSession.md b/build/docs/SecureSession.md index c86b99464..caca54291 100644 --- a/build/docs/SecureSession.md +++ b/build/docs/SecureSession.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SecureSessionEntityListing.md b/build/docs/SecureSessionEntityListing.md index 98bdda647..b6e48ed5a 100644 --- a/build/docs/SecureSessionEntityListing.md +++ b/build/docs/SecureSessionEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SecurityProfile.md b/build/docs/SecurityProfile.md index 4384f98c7..d632b5535 100644 --- a/build/docs/SecurityProfile.md +++ b/build/docs/SecurityProfile.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SecurityProfileEntityListing.md b/build/docs/SecurityProfileEntityListing.md index c73056e0a..e616945d3 100644 --- a/build/docs/SecurityProfileEntityListing.md +++ b/build/docs/SecurityProfileEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Segment.md b/build/docs/Segment.md index 3f8b4dadc..4bac01e8b 100644 --- a/build/docs/Segment.md +++ b/build/docs/Segment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SegmentAssignmentEvent.md b/build/docs/SegmentAssignmentEvent.md index 92024c044..74e795077 100644 --- a/build/docs/SegmentAssignmentEvent.md +++ b/build/docs/SegmentAssignmentEvent.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SegmentDetailQueryClause.md b/build/docs/SegmentDetailQueryClause.md index 70d000beb..a3682dbbc 100644 --- a/build/docs/SegmentDetailQueryClause.md +++ b/build/docs/SegmentDetailQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SegmentDetailQueryFilter.md b/build/docs/SegmentDetailQueryFilter.md index 8cd8cdb25..042c6ac96 100644 --- a/build/docs/SegmentDetailQueryFilter.md +++ b/build/docs/SegmentDetailQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SegmentDetailQueryPredicate.md b/build/docs/SegmentDetailQueryPredicate.md index dae017ec3..cdcca80ab 100644 --- a/build/docs/SegmentDetailQueryPredicate.md +++ b/build/docs/SegmentDetailQueryPredicate.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SegmentEstimateCount.md b/build/docs/SegmentEstimateCount.md index 52d9178b6..b8694d78b 100644 --- a/build/docs/SegmentEstimateCount.md +++ b/build/docs/SegmentEstimateCount.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SegmentListing.md b/build/docs/SegmentListing.md index 2dd340739..e5b3d73ea 100644 --- a/build/docs/SegmentListing.md +++ b/build/docs/SegmentListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SegmentUrl.md b/build/docs/SegmentUrl.md index b0e9191b0..ce019c740 100644 --- a/build/docs/SegmentUrl.md +++ b/build/docs/SegmentUrl.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SelectedAnswer.md b/build/docs/SelectedAnswer.md index 1f249e379..9f4ee126f 100644 --- a/build/docs/SelectedAnswer.md +++ b/build/docs/SelectedAnswer.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SelectedColumns.md b/build/docs/SelectedColumns.md index 6b0cd4229..a9305ad3e 100644 --- a/build/docs/SelectedColumns.md +++ b/build/docs/SelectedColumns.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SelectorEventTrigger.md b/build/docs/SelectorEventTrigger.md index c0fe08397..5e382d718 100644 --- a/build/docs/SelectorEventTrigger.md +++ b/build/docs/SelectorEventTrigger.md @@ -12,4 +12,4 @@ Details about a selector event trigger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SendAgentlessOutboundMessageRequest.md b/build/docs/SendAgentlessOutboundMessageRequest.md index c3b471b7d..263ef6fc6 100644 --- a/build/docs/SendAgentlessOutboundMessageRequest.md +++ b/build/docs/SendAgentlessOutboundMessageRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SendAgentlessOutboundMessageResponse.md b/build/docs/SendAgentlessOutboundMessageResponse.md index 2d709e726..1f7951f3f 100644 --- a/build/docs/SendAgentlessOutboundMessageResponse.md +++ b/build/docs/SendAgentlessOutboundMessageResponse.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SendMessageBody.md b/build/docs/SendMessageBody.md index aac13baf2..8a71ef910 100644 --- a/build/docs/SendMessageBody.md +++ b/build/docs/SendMessageBody.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SendMessagingTemplateRequest.md b/build/docs/SendMessagingTemplateRequest.md index 2fecd460d..72fdf66a8 100644 --- a/build/docs/SendMessagingTemplateRequest.md +++ b/build/docs/SendMessagingTemplateRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SentimentFeedback.md b/build/docs/SentimentFeedback.md index 76e31caa8..075b21dd9 100644 --- a/build/docs/SentimentFeedback.md +++ b/build/docs/SentimentFeedback.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SentimentFeedbackEntityListing.md b/build/docs/SentimentFeedbackEntityListing.md index 1ec4c8aa4..1e4b725c4 100644 --- a/build/docs/SentimentFeedbackEntityListing.md +++ b/build/docs/SentimentFeedbackEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SequenceSchedule.md b/build/docs/SequenceSchedule.md index b87656721..183c71d8d 100644 --- a/build/docs/SequenceSchedule.md +++ b/build/docs/SequenceSchedule.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServerDate.md b/build/docs/ServerDate.md index 9ea81888d..904e800a2 100644 --- a/build/docs/ServerDate.md +++ b/build/docs/ServerDate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServiceGoalTemplate.md b/build/docs/ServiceGoalTemplate.md index 5ceec0a32..00726e7a1 100644 --- a/build/docs/ServiceGoalTemplate.md +++ b/build/docs/ServiceGoalTemplate.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServiceGoalTemplateImpactOverride.md b/build/docs/ServiceGoalTemplateImpactOverride.md index 994af05ab..9ace9f89d 100644 --- a/build/docs/ServiceGoalTemplateImpactOverride.md +++ b/build/docs/ServiceGoalTemplateImpactOverride.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServiceGoalTemplateList.md b/build/docs/ServiceGoalTemplateList.md index 82b97cab8..8de60d421 100644 --- a/build/docs/ServiceGoalTemplateList.md +++ b/build/docs/ServiceGoalTemplateList.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServiceGoalTemplateReference.md b/build/docs/ServiceGoalTemplateReference.md index af29b0fee..6a91d5eb2 100644 --- a/build/docs/ServiceGoalTemplateReference.md +++ b/build/docs/ServiceGoalTemplateReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServiceLevel.md b/build/docs/ServiceLevel.md index 93a0ef3db..109f94faf 100644 --- a/build/docs/ServiceLevel.md +++ b/build/docs/ServiceLevel.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServiceNowSettings.md b/build/docs/ServiceNowSettings.md index 7a1c2a3f6..07fd4613e 100644 --- a/build/docs/ServiceNowSettings.md +++ b/build/docs/ServiceNowSettings.md @@ -9,7 +9,8 @@ | **knowledgeBaseIds** | **[String]** | Filter source by knowledge base ids. | [optional] | | **language** | **String** | Filter source by language. | [optional] | | **categories** | **[String]** | Filter source by categories. | [optional] | +| **baseUrl** | **String** | The base URL to resources. | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServiceNowSourceRequest.md b/build/docs/ServiceNowSourceRequest.md index 773a0be93..f2a714b77 100644 --- a/build/docs/ServiceNowSourceRequest.md +++ b/build/docs/ServiceNowSourceRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ServiceNowSourceResponse.md b/build/docs/ServiceNowSourceResponse.md index b09261bea..e13a282c9 100644 --- a/build/docs/ServiceNowSourceResponse.md +++ b/build/docs/ServiceNowSourceResponse.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Session.md b/build/docs/Session.md index 5cc9a0d07..e04f14116 100644 --- a/build/docs/Session.md +++ b/build/docs/Session.md @@ -56,4 +56,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SessionEndDetails.md b/build/docs/SessionEndDetails.md index 1a1e9f5ce..922ee1580 100644 --- a/build/docs/SessionEndDetails.md +++ b/build/docs/SessionEndDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SessionLastEvent.md b/build/docs/SessionLastEvent.md index 6411bef62..ef8772340 100644 --- a/build/docs/SessionLastEvent.md +++ b/build/docs/SessionLastEvent.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SessionListing.md b/build/docs/SessionListing.md index 305b7ebf9..8fc634b95 100644 --- a/build/docs/SessionListing.md +++ b/build/docs/SessionListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SessionSegmentAssignment.md b/build/docs/SessionSegmentAssignment.md index 23182c5f7..75e541c81 100644 --- a/build/docs/SessionSegmentAssignment.md +++ b/build/docs/SessionSegmentAssignment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SessionsResponse.md b/build/docs/SessionsResponse.md index 8d3e52885..17414e86d 100644 --- a/build/docs/SessionsResponse.md +++ b/build/docs/SessionsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetContentTemplateActionSettings.md b/build/docs/SetContentTemplateActionSettings.md index 4cb4edc99..113509b7f 100644 --- a/build/docs/SetContentTemplateActionSettings.md +++ b/build/docs/SetContentTemplateActionSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetRecordingState.md b/build/docs/SetRecordingState.md index 4197a7268..f6114d2a1 100644 --- a/build/docs/SetRecordingState.md +++ b/build/docs/SetRecordingState.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetSmsPhoneNumberActionSettings.md b/build/docs/SetSmsPhoneNumberActionSettings.md index eb7ded2ff..05c02e908 100644 --- a/build/docs/SetSmsPhoneNumberActionSettings.md +++ b/build/docs/SetSmsPhoneNumberActionSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetTimeOffIntegrationStatusRequest.md b/build/docs/SetTimeOffIntegrationStatusRequest.md index 27c6017b2..70525bed7 100644 --- a/build/docs/SetTimeOffIntegrationStatusRequest.md +++ b/build/docs/SetTimeOffIntegrationStatusRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetTimeOffLimitValuesRequest.md b/build/docs/SetTimeOffLimitValuesRequest.md index 3b823f01f..d1740885d 100644 --- a/build/docs/SetTimeOffLimitValuesRequest.md +++ b/build/docs/SetTimeOffLimitValuesRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetUuiDataRequest.md b/build/docs/SetUuiDataRequest.md index 344445393..2856f74dc 100644 --- a/build/docs/SetUuiDataRequest.md +++ b/build/docs/SetUuiDataRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetWrapperDayOfWeek.md b/build/docs/SetWrapperDayOfWeek.md index 86169e617..eb1b9bb16 100644 --- a/build/docs/SetWrapperDayOfWeek.md +++ b/build/docs/SetWrapperDayOfWeek.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetWrapperRoutePathRequest.md b/build/docs/SetWrapperRoutePathRequest.md index 7cdfb4013..6b858cc55 100644 --- a/build/docs/SetWrapperRoutePathRequest.md +++ b/build/docs/SetWrapperRoutePathRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetWrapperString.md b/build/docs/SetWrapperString.md index 7b413a466..9ffbc12c3 100644 --- a/build/docs/SetWrapperString.md +++ b/build/docs/SetWrapperString.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SetWrapperSyncTimeOffProperty.md b/build/docs/SetWrapperSyncTimeOffProperty.md index 6eca6ab52..0dcb1bd8a 100644 --- a/build/docs/SetWrapperSyncTimeOffProperty.md +++ b/build/docs/SetWrapperSyncTimeOffProperty.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SettingDirection.md b/build/docs/SettingDirection.md index b77017bd0..9ed18af81 100644 --- a/build/docs/SettingDirection.md +++ b/build/docs/SettingDirection.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Settings.md b/build/docs/Settings.md index 2304d6b9c..d9f6b1dfd 100644 --- a/build/docs/Settings.md +++ b/build/docs/Settings.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SettingsAPI.md b/build/docs/SettingsAPI.md index 8283a7e24..9aba4e064 100644 --- a/build/docs/SettingsAPI.md +++ b/build/docs/SettingsAPI.md @@ -414,4 +414,4 @@ SettingsAPI.putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId: agentId, bod [**AutoAnswerSettings**](AutoAnswerSettings) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Share.md b/build/docs/Share.md index 31c34a35a..874406e88 100644 --- a/build/docs/Share.md +++ b/build/docs/Share.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShareEntityListing.md b/build/docs/ShareEntityListing.md index 8bd50423a..1ff825923 100644 --- a/build/docs/ShareEntityListing.md +++ b/build/docs/ShareEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SharedEntity.md b/build/docs/SharedEntity.md index 0630d26bb..a5b676c74 100644 --- a/build/docs/SharedEntity.md +++ b/build/docs/SharedEntity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SharedResponse.md b/build/docs/SharedResponse.md index 02db943ec..ee31ac426 100644 --- a/build/docs/SharedResponse.md +++ b/build/docs/SharedResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftStartVariance.md b/build/docs/ShiftStartVariance.md index 226b35ae9..9719e3254 100644 --- a/build/docs/ShiftStartVariance.md +++ b/build/docs/ShiftStartVariance.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeActivityPreviewResponse.md b/build/docs/ShiftTradeActivityPreviewResponse.md index d0796aeb7..5ea68533d 100644 --- a/build/docs/ShiftTradeActivityPreviewResponse.md +++ b/build/docs/ShiftTradeActivityPreviewResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeActivityRule.md b/build/docs/ShiftTradeActivityRule.md index 32bfbfe90..dbafeb6e5 100644 --- a/build/docs/ShiftTradeActivityRule.md +++ b/build/docs/ShiftTradeActivityRule.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeListResponse.md b/build/docs/ShiftTradeListResponse.md index 6ed939249..e8b834b6f 100644 --- a/build/docs/ShiftTradeListResponse.md +++ b/build/docs/ShiftTradeListResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeMatchReviewResponse.md b/build/docs/ShiftTradeMatchReviewResponse.md index da969988b..566aea765 100644 --- a/build/docs/ShiftTradeMatchReviewResponse.md +++ b/build/docs/ShiftTradeMatchReviewResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeMatchReviewUserResponse.md b/build/docs/ShiftTradeMatchReviewUserResponse.md index 8ff628f68..c91ff4f7b 100644 --- a/build/docs/ShiftTradeMatchReviewUserResponse.md +++ b/build/docs/ShiftTradeMatchReviewUserResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeMatchViolation.md b/build/docs/ShiftTradeMatchViolation.md index 9ec66dd02..72a6be958 100644 --- a/build/docs/ShiftTradeMatchViolation.md +++ b/build/docs/ShiftTradeMatchViolation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeMatchesSummaryResponse.md b/build/docs/ShiftTradeMatchesSummaryResponse.md index d2ba07a44..b6ae64ce0 100644 --- a/build/docs/ShiftTradeMatchesSummaryResponse.md +++ b/build/docs/ShiftTradeMatchesSummaryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeNotification.md b/build/docs/ShiftTradeNotification.md index eb68585eb..85aed8553 100644 --- a/build/docs/ShiftTradeNotification.md +++ b/build/docs/ShiftTradeNotification.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradePreviewResponse.md b/build/docs/ShiftTradePreviewResponse.md index 9894fc0c5..45ffffc26 100644 --- a/build/docs/ShiftTradePreviewResponse.md +++ b/build/docs/ShiftTradePreviewResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeResponse.md b/build/docs/ShiftTradeResponse.md index 3c63f2250..53bf09fbf 100644 --- a/build/docs/ShiftTradeResponse.md +++ b/build/docs/ShiftTradeResponse.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShiftTradeSettings.md b/build/docs/ShiftTradeSettings.md index 56926eb86..c862c69a5 100644 --- a/build/docs/ShiftTradeSettings.md +++ b/build/docs/ShiftTradeSettings.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShortTermForecastReference.md b/build/docs/ShortTermForecastReference.md index b88f75fa3..a2f9c3379 100644 --- a/build/docs/ShortTermForecastReference.md +++ b/build/docs/ShortTermForecastReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShortTermForecastingSettings.md b/build/docs/ShortTermForecastingSettings.md index 08dd60a26..bfa1477bc 100644 --- a/build/docs/ShortTermForecastingSettings.md +++ b/build/docs/ShortTermForecastingSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShrinkageOverride.md b/build/docs/ShrinkageOverride.md index c38b3b841..84d77ea21 100644 --- a/build/docs/ShrinkageOverride.md +++ b/build/docs/ShrinkageOverride.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ShrinkageOverrides.md b/build/docs/ShrinkageOverrides.md index 3771d31f7..3c7026f72 100644 --- a/build/docs/ShrinkageOverrides.md +++ b/build/docs/ShrinkageOverrides.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Signature.md b/build/docs/Signature.md index e18b77062..84ae46af5 100644 --- a/build/docs/Signature.md +++ b/build/docs/Signature.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SignedData.md b/build/docs/SignedData.md index 80d05306c..fea55584d 100644 --- a/build/docs/SignedData.md +++ b/build/docs/SignedData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SignedUrlResponse.md b/build/docs/SignedUrlResponse.md index 52f63cc72..244f13777 100644 --- a/build/docs/SignedUrlResponse.md +++ b/build/docs/SignedUrlResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SingleWorkdayAveragePoints.md b/build/docs/SingleWorkdayAveragePoints.md index c21af1151..c9e212991 100644 --- a/build/docs/SingleWorkdayAveragePoints.md +++ b/build/docs/SingleWorkdayAveragePoints.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SingleWorkdayAverageValues.md b/build/docs/SingleWorkdayAverageValues.md index adcc9d3a5..891572478 100644 --- a/build/docs/SingleWorkdayAverageValues.md +++ b/build/docs/SingleWorkdayAverageValues.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SipDownloadResponse.md b/build/docs/SipDownloadResponse.md index a2d655c34..aa197e197 100644 --- a/build/docs/SipDownloadResponse.md +++ b/build/docs/SipDownloadResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SipSearchResult.md b/build/docs/SipSearchResult.md index 14e952da7..87b1f758b 100644 --- a/build/docs/SipSearchResult.md +++ b/build/docs/SipSearchResult.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Site.md b/build/docs/Site.md index f90f4ccdc..8c8305c8b 100644 --- a/build/docs/Site.md +++ b/build/docs/Site.md @@ -40,4 +40,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SiteConnection.md b/build/docs/SiteConnection.md index 62527e52d..7fe33f67c 100644 --- a/build/docs/SiteConnection.md +++ b/build/docs/SiteConnection.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SiteConnections.md b/build/docs/SiteConnections.md index 53ead4675..c18c17889 100644 --- a/build/docs/SiteConnections.md +++ b/build/docs/SiteConnections.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SiteEntityListing.md b/build/docs/SiteEntityListing.md index 68c6e0213..f9b7626c3 100644 --- a/build/docs/SiteEntityListing.md +++ b/build/docs/SiteEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SiteSearchCriteria.md b/build/docs/SiteSearchCriteria.md index 69f7c356f..2ee634e9d 100644 --- a/build/docs/SiteSearchCriteria.md +++ b/build/docs/SiteSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SiteSearchRequest.md b/build/docs/SiteSearchRequest.md index d390c8307..bc83dabcd 100644 --- a/build/docs/SiteSearchRequest.md +++ b/build/docs/SiteSearchRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SitesSearchResponse.md b/build/docs/SitesSearchResponse.md index 255f381d7..41e2fd0a7 100644 --- a/build/docs/SitesSearchResponse.md +++ b/build/docs/SitesSearchResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillCombinationInfo.md b/build/docs/SkillCombinationInfo.md index 64037acc1..5859dc12b 100644 --- a/build/docs/SkillCombinationInfo.md +++ b/build/docs/SkillCombinationInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillEntityListing.md b/build/docs/SkillEntityListing.md index e19106185..aff43fa31 100644 --- a/build/docs/SkillEntityListing.md +++ b/build/docs/SkillEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroup.md b/build/docs/SkillGroup.md index 2f74c60c0..d4f236a52 100644 --- a/build/docs/SkillGroup.md +++ b/build/docs/SkillGroup.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupCondition.md b/build/docs/SkillGroupCondition.md index c405a9ada..98b4360ee 100644 --- a/build/docs/SkillGroupCondition.md +++ b/build/docs/SkillGroupCondition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupDefinition.md b/build/docs/SkillGroupDefinition.md index 377ab4969..709aaf0a3 100644 --- a/build/docs/SkillGroupDefinition.md +++ b/build/docs/SkillGroupDefinition.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupEntityListing.md b/build/docs/SkillGroupEntityListing.md index d14bc00fb..6c1493d7f 100644 --- a/build/docs/SkillGroupEntityListing.md +++ b/build/docs/SkillGroupEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupLanguageCondition.md b/build/docs/SkillGroupLanguageCondition.md index b24242389..d8a82cbfa 100644 --- a/build/docs/SkillGroupLanguageCondition.md +++ b/build/docs/SkillGroupLanguageCondition.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupMemberDivisionList.md b/build/docs/SkillGroupMemberDivisionList.md index fa5005742..e802c1673 100644 --- a/build/docs/SkillGroupMemberDivisionList.md +++ b/build/docs/SkillGroupMemberDivisionList.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupMemberDivisions.md b/build/docs/SkillGroupMemberDivisions.md index 9315e3904..6c828243e 100644 --- a/build/docs/SkillGroupMemberDivisions.md +++ b/build/docs/SkillGroupMemberDivisions.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupMemberEntityListing.md b/build/docs/SkillGroupMemberEntityListing.md index 9a99c3ff5..b55f84b6b 100644 --- a/build/docs/SkillGroupMemberEntityListing.md +++ b/build/docs/SkillGroupMemberEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupRoutingCondition.md b/build/docs/SkillGroupRoutingCondition.md index 87ff4e227..f25063439 100644 --- a/build/docs/SkillGroupRoutingCondition.md +++ b/build/docs/SkillGroupRoutingCondition.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillGroupWithMemberDivisions.md b/build/docs/SkillGroupWithMemberDivisions.md index 955db50c1..2c23779ef 100644 --- a/build/docs/SkillGroupWithMemberDivisions.md +++ b/build/docs/SkillGroupWithMemberDivisions.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SkillsToRemove.md b/build/docs/SkillsToRemove.md index a301475fa..2aab4da72 100644 --- a/build/docs/SkillsToRemove.md +++ b/build/docs/SkillsToRemove.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsAddress.md b/build/docs/SmsAddress.md index b884e5253..06ee09b4d 100644 --- a/build/docs/SmsAddress.md +++ b/build/docs/SmsAddress.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsAddressEntityListing.md b/build/docs/SmsAddressEntityListing.md index 209cddd4e..e2b0f2f43 100644 --- a/build/docs/SmsAddressEntityListing.md +++ b/build/docs/SmsAddressEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsAddressProvision.md b/build/docs/SmsAddressProvision.md index f5aaec01e..b6c9b1591 100644 --- a/build/docs/SmsAddressProvision.md +++ b/build/docs/SmsAddressProvision.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsAvailablePhoneNumber.md b/build/docs/SmsAvailablePhoneNumber.md index f8c694eea..091a76de2 100644 --- a/build/docs/SmsAvailablePhoneNumber.md +++ b/build/docs/SmsAvailablePhoneNumber.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsConfig.md b/build/docs/SmsConfig.md index 41ef20287..b008b662a 100644 --- a/build/docs/SmsConfig.md +++ b/build/docs/SmsConfig.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsPhoneNumber.md b/build/docs/SmsPhoneNumber.md index 7590a1e5f..2317af243 100644 --- a/build/docs/SmsPhoneNumber.md +++ b/build/docs/SmsPhoneNumber.md @@ -36,4 +36,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsPhoneNumberEntityListing.md b/build/docs/SmsPhoneNumberEntityListing.md index 65ebb1107..dc4cdcaa6 100644 --- a/build/docs/SmsPhoneNumberEntityListing.md +++ b/build/docs/SmsPhoneNumberEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsPhoneNumberImport.md b/build/docs/SmsPhoneNumberImport.md index 235fa4d2e..be186cbbd 100644 --- a/build/docs/SmsPhoneNumberImport.md +++ b/build/docs/SmsPhoneNumberImport.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsPhoneNumberProvision.md b/build/docs/SmsPhoneNumberProvision.md index 532afbf96..c26b3e040 100644 --- a/build/docs/SmsPhoneNumberProvision.md +++ b/build/docs/SmsPhoneNumberProvision.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsPhoneNumberRef.md b/build/docs/SmsPhoneNumberRef.md index 07cc5772a..c670437f4 100644 --- a/build/docs/SmsPhoneNumberRef.md +++ b/build/docs/SmsPhoneNumberRef.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SmsProvisioningStatus.md b/build/docs/SmsProvisioningStatus.md index 2327f05ab..26360fba9 100644 --- a/build/docs/SmsProvisioningStatus.md +++ b/build/docs/SmsProvisioningStatus.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SocialExpression.md b/build/docs/SocialExpression.md index ff1c19242..7c8288c95 100644 --- a/build/docs/SocialExpression.md +++ b/build/docs/SocialExpression.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SocialHandle.md b/build/docs/SocialHandle.md index acf3c328d..5ab84b752 100644 --- a/build/docs/SocialHandle.md +++ b/build/docs/SocialHandle.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SocialKeyword.md b/build/docs/SocialKeyword.md index 85ca8fe39..c624d50ed 100644 --- a/build/docs/SocialKeyword.md +++ b/build/docs/SocialKeyword.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SortItem.md b/build/docs/SortItem.md index 56cc9f65c..c45705fed 100644 --- a/build/docs/SortItem.md +++ b/build/docs/SortItem.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Source.md b/build/docs/Source.md index fcdd7118e..45d76749b 100644 --- a/build/docs/Source.md +++ b/build/docs/Source.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SourceBaseResponse.md b/build/docs/SourceBaseResponse.md index 2c09ae0b8..887eb9942 100644 --- a/build/docs/SourceBaseResponse.md +++ b/build/docs/SourceBaseResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SourceConfiguration.md b/build/docs/SourceConfiguration.md index c9db7e54d..a5a4e232c 100644 --- a/build/docs/SourceConfiguration.md +++ b/build/docs/SourceConfiguration.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SourceEntity.md b/build/docs/SourceEntity.md index 79a5012ca..f8e8f82ea 100644 --- a/build/docs/SourceEntity.md +++ b/build/docs/SourceEntity.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SourceEntityListing.md b/build/docs/SourceEntityListing.md index f99edd805..5de117b1f 100644 --- a/build/docs/SourceEntityListing.md +++ b/build/docs/SourceEntityListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SourceLastSync.md b/build/docs/SourceLastSync.md index 9c91a0200..6595162d6 100644 --- a/build/docs/SourceLastSync.md +++ b/build/docs/SourceLastSync.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SourcePlanningGroupRequest.md b/build/docs/SourcePlanningGroupRequest.md index 7265102c7..ac7aefd03 100644 --- a/build/docs/SourcePlanningGroupRequest.md +++ b/build/docs/SourcePlanningGroupRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SourceSyncResponse.md b/build/docs/SourceSyncResponse.md index b378d9717..c88580c02 100644 --- a/build/docs/SourceSyncResponse.md +++ b/build/docs/SourceSyncResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SpeechTextAnalyticsAPI.md b/build/docs/SpeechTextAnalyticsAPI.md index 95da9c1aa..23d4fdf98 100644 --- a/build/docs/SpeechTextAnalyticsAPI.md +++ b/build/docs/SpeechTextAnalyticsAPI.md @@ -2546,4 +2546,4 @@ SpeechTextAnalyticsAPI.putSpeechandtextanalyticsTopic(topicId: topicId, body: bo [**Topic**](Topic) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SpeechTextAnalyticsSettingsRequest.md b/build/docs/SpeechTextAnalyticsSettingsRequest.md index 0985cfecf..075fe78c5 100644 --- a/build/docs/SpeechTextAnalyticsSettingsRequest.md +++ b/build/docs/SpeechTextAnalyticsSettingsRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SpeechTextAnalyticsSettingsResponse.md b/build/docs/SpeechTextAnalyticsSettingsResponse.md index cf8a9fbcb..d11725459 100644 --- a/build/docs/SpeechTextAnalyticsSettingsResponse.md +++ b/build/docs/SpeechTextAnalyticsSettingsResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SplittingInformation.md b/build/docs/SplittingInformation.md index df727005b..fab96fff0 100644 --- a/build/docs/SplittingInformation.md +++ b/build/docs/SplittingInformation.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StaCategory.md b/build/docs/StaCategory.md index 236f64726..d4d86681b 100644 --- a/build/docs/StaCategory.md +++ b/build/docs/StaCategory.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StaffingGroupListing.md b/build/docs/StaffingGroupListing.md index 456913647..951c7e4b5 100644 --- a/build/docs/StaffingGroupListing.md +++ b/build/docs/StaffingGroupListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StaffingGroupReference.md b/build/docs/StaffingGroupReference.md index 5819ecab6..611c65a39 100644 --- a/build/docs/StaffingGroupReference.md +++ b/build/docs/StaffingGroupReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StaffingGroupResponse.md b/build/docs/StaffingGroupResponse.md index 9f2962478..7799a9ac0 100644 --- a/build/docs/StaffingGroupResponse.md +++ b/build/docs/StaffingGroupResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StaffingRequirementsPlanningGroupData.md b/build/docs/StaffingRequirementsPlanningGroupData.md index 0a0598c51..1e41bad5f 100644 --- a/build/docs/StaffingRequirementsPlanningGroupData.md +++ b/build/docs/StaffingRequirementsPlanningGroupData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StarrableDivision.md b/build/docs/StarrableDivision.md index 334488e4e..605b4c2d2 100644 --- a/build/docs/StarrableDivision.md +++ b/build/docs/StarrableDivision.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventCampaignTopicIntervalMetrics.md b/build/docs/StatEventCampaignTopicIntervalMetrics.md index e70a5aef3..f5ec64090 100644 --- a/build/docs/StatEventCampaignTopicIntervalMetrics.md +++ b/build/docs/StatEventCampaignTopicIntervalMetrics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventCampaignTopicMetricStats.md b/build/docs/StatEventCampaignTopicMetricStats.md index e9b8a5050..9629317de 100644 --- a/build/docs/StatEventCampaignTopicMetricStats.md +++ b/build/docs/StatEventCampaignTopicMetricStats.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventCampaignTopicStatsNotification.md b/build/docs/StatEventCampaignTopicStatsNotification.md index aee46c824..8ba265260 100644 --- a/build/docs/StatEventCampaignTopicStatsNotification.md +++ b/build/docs/StatEventCampaignTopicStatsNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventFlowOutcomeTopicIntervalMetrics.md b/build/docs/StatEventFlowOutcomeTopicIntervalMetrics.md index cb6cb7e5a..cf9e28ae7 100644 --- a/build/docs/StatEventFlowOutcomeTopicIntervalMetrics.md +++ b/build/docs/StatEventFlowOutcomeTopicIntervalMetrics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventFlowOutcomeTopicMetricStats.md b/build/docs/StatEventFlowOutcomeTopicMetricStats.md index 6dcb9b1ff..dd18e4a0d 100644 --- a/build/docs/StatEventFlowOutcomeTopicMetricStats.md +++ b/build/docs/StatEventFlowOutcomeTopicMetricStats.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventFlowOutcomeTopicStatsNotification.md b/build/docs/StatEventFlowOutcomeTopicStatsNotification.md index dd1e660f5..76c635f17 100644 --- a/build/docs/StatEventFlowOutcomeTopicStatsNotification.md +++ b/build/docs/StatEventFlowOutcomeTopicStatsNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventFlowTopicIntervalMetrics.md b/build/docs/StatEventFlowTopicIntervalMetrics.md index 9a991ed7f..e825d59e6 100644 --- a/build/docs/StatEventFlowTopicIntervalMetrics.md +++ b/build/docs/StatEventFlowTopicIntervalMetrics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventFlowTopicMetricStats.md b/build/docs/StatEventFlowTopicMetricStats.md index 5b78010fa..af5f05fb1 100644 --- a/build/docs/StatEventFlowTopicMetricStats.md +++ b/build/docs/StatEventFlowTopicMetricStats.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventFlowTopicStatsNotification.md b/build/docs/StatEventFlowTopicStatsNotification.md index c2a974182..9e7003cf6 100644 --- a/build/docs/StatEventFlowTopicStatsNotification.md +++ b/build/docs/StatEventFlowTopicStatsNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventQueueTopicIntervalMetrics.md b/build/docs/StatEventQueueTopicIntervalMetrics.md index a56f8e00b..bc5140c6e 100644 --- a/build/docs/StatEventQueueTopicIntervalMetrics.md +++ b/build/docs/StatEventQueueTopicIntervalMetrics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventQueueTopicMetricStats.md b/build/docs/StatEventQueueTopicMetricStats.md index 5224ee078..0806546cf 100644 --- a/build/docs/StatEventQueueTopicMetricStats.md +++ b/build/docs/StatEventQueueTopicMetricStats.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventQueueTopicStatsNotification.md b/build/docs/StatEventQueueTopicStatsNotification.md index 1dd80ceed..ea1d0abd9 100644 --- a/build/docs/StatEventQueueTopicStatsNotification.md +++ b/build/docs/StatEventQueueTopicStatsNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventUserTopicIntervalMetrics.md b/build/docs/StatEventUserTopicIntervalMetrics.md index 156988434..d4b309c9c 100644 --- a/build/docs/StatEventUserTopicIntervalMetrics.md +++ b/build/docs/StatEventUserTopicIntervalMetrics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventUserTopicMetricStats.md b/build/docs/StatEventUserTopicMetricStats.md index 04a072976..92d3003c1 100644 --- a/build/docs/StatEventUserTopicMetricStats.md +++ b/build/docs/StatEventUserTopicMetricStats.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventUserTopicStatsNotification.md b/build/docs/StatEventUserTopicStatsNotification.md index 768e2326e..06f07a9de 100644 --- a/build/docs/StatEventUserTopicStatsNotification.md +++ b/build/docs/StatEventUserTopicStatsNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventWrapUpCodeTopicIntervalMetrics.md b/build/docs/StatEventWrapUpCodeTopicIntervalMetrics.md index d0c10c404..8a4355ccd 100644 --- a/build/docs/StatEventWrapUpCodeTopicIntervalMetrics.md +++ b/build/docs/StatEventWrapUpCodeTopicIntervalMetrics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventWrapUpCodeTopicMetricStats.md b/build/docs/StatEventWrapUpCodeTopicMetricStats.md index e41243fcf..4498a64b6 100644 --- a/build/docs/StatEventWrapUpCodeTopicMetricStats.md +++ b/build/docs/StatEventWrapUpCodeTopicMetricStats.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatEventWrapUpCodeTopicStatsNotification.md b/build/docs/StatEventWrapUpCodeTopicStatsNotification.md index 613eced28..d3ff88873 100644 --- a/build/docs/StatEventWrapUpCodeTopicStatsNotification.md +++ b/build/docs/StatEventWrapUpCodeTopicStatsNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Station.md b/build/docs/Station.md index cea03755d..b8a09e3b4 100644 --- a/build/docs/Station.md +++ b/build/docs/Station.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StationEntityListing.md b/build/docs/StationEntityListing.md index ccf2d3aff..05e88f1cd 100644 --- a/build/docs/StationEntityListing.md +++ b/build/docs/StationEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StationsAPI.md b/build/docs/StationsAPI.md index 63141f271..8c1b9696b 100644 --- a/build/docs/StationsAPI.md +++ b/build/docs/StationsAPI.md @@ -170,4 +170,4 @@ StationsAPI.getStations(pageSize: pageSize, pageNumber: pageNumber, sortBy: sort [**StationEntityListing**](StationEntityListing) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatisticalResponse.md b/build/docs/StatisticalResponse.md index 683995db5..08f34b5cb 100644 --- a/build/docs/StatisticalResponse.md +++ b/build/docs/StatisticalResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatisticalSummary.md b/build/docs/StatisticalSummary.md index c8702fb79..5c3ea8c47 100644 --- a/build/docs/StatisticalSummary.md +++ b/build/docs/StatisticalSummary.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StatusChange.md b/build/docs/StatusChange.md index 2fc9dd156..2f47164be 100644 --- a/build/docs/StatusChange.md +++ b/build/docs/StatusChange.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StopSettings.md b/build/docs/StopSettings.md index b209ff770..e3a7a4098 100644 --- a/build/docs/StopSettings.md +++ b/build/docs/StopSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StorySetting.md b/build/docs/StorySetting.md index ba27b7a1a..6e634ebac 100644 --- a/build/docs/StorySetting.md +++ b/build/docs/StorySetting.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/StreetAddress.md b/build/docs/StreetAddress.md index afcd40396..fdc2d1790 100644 --- a/build/docs/StreetAddress.md +++ b/build/docs/StreetAddress.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SttEngineEntity.md b/build/docs/SttEngineEntity.md index a5294aa87..9c76c79ed 100644 --- a/build/docs/SttEngineEntity.md +++ b/build/docs/SttEngineEntity.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SttEngineEntityListing.md b/build/docs/SttEngineEntityListing.md index 318540e69..de4465326 100644 --- a/build/docs/SttEngineEntityListing.md +++ b/build/docs/SttEngineEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SubjectDivisionGrants.md b/build/docs/SubjectDivisionGrants.md index 530272e58..f583f24d1 100644 --- a/build/docs/SubjectDivisionGrants.md +++ b/build/docs/SubjectDivisionGrants.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SubjectDivisionGrantsEntityListing.md b/build/docs/SubjectDivisionGrantsEntityListing.md index f95fb6a2c..614fe7a09 100644 --- a/build/docs/SubjectDivisionGrantsEntityListing.md +++ b/build/docs/SubjectDivisionGrantsEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SubjectDivisions.md b/build/docs/SubjectDivisions.md index ba8055f82..65803d3ed 100644 --- a/build/docs/SubjectDivisions.md +++ b/build/docs/SubjectDivisions.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SubscriberResponse.md b/build/docs/SubscriberResponse.md index ffaf295b0..3ea2390e3 100644 --- a/build/docs/SubscriberResponse.md +++ b/build/docs/SubscriberResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Subscription.md b/build/docs/Subscription.md index 22971f5a8..fa344e87b 100644 --- a/build/docs/Subscription.md +++ b/build/docs/Subscription.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SubscriptionOverviewUsage.md b/build/docs/SubscriptionOverviewUsage.md index 7c23675fb..3ddfb7aa6 100644 --- a/build/docs/SubscriptionOverviewUsage.md +++ b/build/docs/SubscriptionOverviewUsage.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestAPI.md b/build/docs/SuggestAPI.md index 31b12131a..3d9f63bda 100644 --- a/build/docs/SuggestAPI.md +++ b/build/docs/SuggestAPI.md @@ -223,4 +223,4 @@ SuggestAPI.postSearchSuggest(body: body, profile: profile) { (response, error) i [**JsonNodeSearchResponse**](JsonNodeSearchResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestSearchCriteria.md b/build/docs/SuggestSearchCriteria.md index fef630971..a031295e2 100644 --- a/build/docs/SuggestSearchCriteria.md +++ b/build/docs/SuggestSearchCriteria.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestSearchRequest.md b/build/docs/SuggestSearchRequest.md index 077018dc8..c4d315298 100644 --- a/build/docs/SuggestSearchRequest.md +++ b/build/docs/SuggestSearchRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Suggestion.md b/build/docs/Suggestion.md index 837f14bd1..785b5d3d5 100644 --- a/build/docs/Suggestion.md +++ b/build/docs/Suggestion.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionCannedResponse.md b/build/docs/SuggestionCannedResponse.md index ac955c94a..e93ab3191 100644 --- a/build/docs/SuggestionCannedResponse.md +++ b/build/docs/SuggestionCannedResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionContext.md b/build/docs/SuggestionContext.md index 657e9638f..b18b91aea 100644 --- a/build/docs/SuggestionContext.md +++ b/build/docs/SuggestionContext.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionEngagement.md b/build/docs/SuggestionEngagement.md index 2545ff5f0..ffd8fb88b 100644 --- a/build/docs/SuggestionEngagement.md +++ b/build/docs/SuggestionEngagement.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionFeedback.md b/build/docs/SuggestionFeedback.md index 3765fb383..f4e0c4010 100644 --- a/build/docs/SuggestionFeedback.md +++ b/build/docs/SuggestionFeedback.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionKnowledgeAnswer.md b/build/docs/SuggestionKnowledgeAnswer.md index 7282ee0a9..0776a8b7c 100644 --- a/build/docs/SuggestionKnowledgeAnswer.md +++ b/build/docs/SuggestionKnowledgeAnswer.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionKnowledgeArticle.md b/build/docs/SuggestionKnowledgeArticle.md index bf2ab82b8..9d408b04c 100644 --- a/build/docs/SuggestionKnowledgeArticle.md +++ b/build/docs/SuggestionKnowledgeArticle.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionKnowledgeSearch.md b/build/docs/SuggestionKnowledgeSearch.md index 11c650d83..60c222ee7 100644 --- a/build/docs/SuggestionKnowledgeSearch.md +++ b/build/docs/SuggestionKnowledgeSearch.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionListing.md b/build/docs/SuggestionListing.md index 02967c014..fa55e2bfa 100644 --- a/build/docs/SuggestionListing.md +++ b/build/docs/SuggestionListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SuggestionScript.md b/build/docs/SuggestionScript.md index 8e873dfc7..bf102cb6d 100644 --- a/build/docs/SuggestionScript.md +++ b/build/docs/SuggestionScript.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SummaryGenerationConfig.md b/build/docs/SummaryGenerationConfig.md index ee37b3bb3..90ca9e99d 100644 --- a/build/docs/SummaryGenerationConfig.md +++ b/build/docs/SummaryGenerationConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterCategory.md b/build/docs/SupportCenterCategory.md index 967c3482a..5f6cad308 100644 --- a/build/docs/SupportCenterCategory.md +++ b/build/docs/SupportCenterCategory.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterCompactCategoryModuleTemplate.md b/build/docs/SupportCenterCompactCategoryModuleTemplate.md index 2348d45fe..f34b8ca3e 100644 --- a/build/docs/SupportCenterCompactCategoryModuleTemplate.md +++ b/build/docs/SupportCenterCompactCategoryModuleTemplate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterCustomMessage.md b/build/docs/SupportCenterCustomMessage.md index c6c6a2ade..042508a55 100644 --- a/build/docs/SupportCenterCustomMessage.md +++ b/build/docs/SupportCenterCustomMessage.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterDetailedCategoryModuleSidebar.md b/build/docs/SupportCenterDetailedCategoryModuleSidebar.md index 62122bfe3..b90c68242 100644 --- a/build/docs/SupportCenterDetailedCategoryModuleSidebar.md +++ b/build/docs/SupportCenterDetailedCategoryModuleSidebar.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterDetailedCategoryModuleTemplate.md b/build/docs/SupportCenterDetailedCategoryModuleTemplate.md index af216c406..54dd2d5be 100644 --- a/build/docs/SupportCenterDetailedCategoryModuleTemplate.md +++ b/build/docs/SupportCenterDetailedCategoryModuleTemplate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterFeedbackSettings.md b/build/docs/SupportCenterFeedbackSettings.md index 72069d3dc..47495c13d 100644 --- a/build/docs/SupportCenterFeedbackSettings.md +++ b/build/docs/SupportCenterFeedbackSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterGlobalStyle.md b/build/docs/SupportCenterGlobalStyle.md index a190211d2..5cebe8873 100644 --- a/build/docs/SupportCenterGlobalStyle.md +++ b/build/docs/SupportCenterGlobalStyle.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterHeroStyle.md b/build/docs/SupportCenterHeroStyle.md index f7a1a06e8..19a998345 100644 --- a/build/docs/SupportCenterHeroStyle.md +++ b/build/docs/SupportCenterHeroStyle.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterImage.md b/build/docs/SupportCenterImage.md index 0e567ec30..882818ccb 100644 --- a/build/docs/SupportCenterImage.md +++ b/build/docs/SupportCenterImage.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterImageSource.md b/build/docs/SupportCenterImageSource.md index 9921e0bb5..405ac405b 100644 --- a/build/docs/SupportCenterImageSource.md +++ b/build/docs/SupportCenterImageSource.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterLabelFilter.md b/build/docs/SupportCenterLabelFilter.md index b153c3883..7bb2e3aef 100644 --- a/build/docs/SupportCenterLabelFilter.md +++ b/build/docs/SupportCenterLabelFilter.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterModuleSetting.md b/build/docs/SupportCenterModuleSetting.md index cb15ad809..927125d63 100644 --- a/build/docs/SupportCenterModuleSetting.md +++ b/build/docs/SupportCenterModuleSetting.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterScreen.md b/build/docs/SupportCenterScreen.md index 4d41ac342..a9a224fe0 100644 --- a/build/docs/SupportCenterScreen.md +++ b/build/docs/SupportCenterScreen.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterSettings.md b/build/docs/SupportCenterSettings.md index 71378e474..c9f2ab53f 100644 --- a/build/docs/SupportCenterSettings.md +++ b/build/docs/SupportCenterSettings.md @@ -19,4 +19,4 @@ Settings concerning knowledge portal (previously support center) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportCenterStyleSetting.md b/build/docs/SupportCenterStyleSetting.md index 192aa2dba..b64ac0a04 100644 --- a/build/docs/SupportCenterStyleSetting.md +++ b/build/docs/SupportCenterStyleSetting.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportedContent.md b/build/docs/SupportedContent.md index fbcfeb00b..f78cc89a5 100644 --- a/build/docs/SupportedContent.md +++ b/build/docs/SupportedContent.md @@ -19,4 +19,4 @@ Supported content profile for inbound and outbound messages -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportedContentListing.md b/build/docs/SupportedContentListing.md index 74c54babe..d2d0f2c4a 100644 --- a/build/docs/SupportedContentListing.md +++ b/build/docs/SupportedContentListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportedContentReference.md b/build/docs/SupportedContentReference.md index bf01a7f29..136f7bba7 100644 --- a/build/docs/SupportedContentReference.md +++ b/build/docs/SupportedContentReference.md @@ -14,4 +14,4 @@ Reference to supported content profile associated with the integration -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportedDialectsEntityListing.md b/build/docs/SupportedDialectsEntityListing.md index 0b6ccefd8..f070d69ed 100644 --- a/build/docs/SupportedDialectsEntityListing.md +++ b/build/docs/SupportedDialectsEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportedDialectsTranscriptionEngine.md b/build/docs/SupportedDialectsTranscriptionEngine.md index 6f6fc03d9..e46413de3 100644 --- a/build/docs/SupportedDialectsTranscriptionEngine.md +++ b/build/docs/SupportedDialectsTranscriptionEngine.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SupportedLanguage.md b/build/docs/SupportedLanguage.md index 951b6ccfe..a88a6b068 100644 --- a/build/docs/SupportedLanguage.md +++ b/build/docs/SupportedLanguage.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Survey.md b/build/docs/Survey.md index 171bbaefb..c55f408d8 100644 --- a/build/docs/Survey.md +++ b/build/docs/Survey.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyAggregateDataContainer.md b/build/docs/SurveyAggregateDataContainer.md index 5f9ff4ef0..faf55b33c 100644 --- a/build/docs/SurveyAggregateDataContainer.md +++ b/build/docs/SurveyAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyAggregateQueryClause.md b/build/docs/SurveyAggregateQueryClause.md index fd87f7c98..a660c9e6a 100644 --- a/build/docs/SurveyAggregateQueryClause.md +++ b/build/docs/SurveyAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyAggregateQueryFilter.md b/build/docs/SurveyAggregateQueryFilter.md index 9de10562b..182c941ed 100644 --- a/build/docs/SurveyAggregateQueryFilter.md +++ b/build/docs/SurveyAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyAggregateQueryPredicate.md b/build/docs/SurveyAggregateQueryPredicate.md index 22b0aec8f..95b1972f8 100644 --- a/build/docs/SurveyAggregateQueryPredicate.md +++ b/build/docs/SurveyAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyAggregateQueryResponse.md b/build/docs/SurveyAggregateQueryResponse.md index e8a68bec1..8f1b355ce 100644 --- a/build/docs/SurveyAggregateQueryResponse.md +++ b/build/docs/SurveyAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyAggregationQuery.md b/build/docs/SurveyAggregationQuery.md index c08e0f09d..4514df062 100644 --- a/build/docs/SurveyAggregationQuery.md +++ b/build/docs/SurveyAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyAggregationView.md b/build/docs/SurveyAggregationView.md index 891035cdb..028eb899b 100644 --- a/build/docs/SurveyAggregationView.md +++ b/build/docs/SurveyAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyAssignment.md b/build/docs/SurveyAssignment.md index 6974dd3e3..175523f4f 100644 --- a/build/docs/SurveyAssignment.md +++ b/build/docs/SurveyAssignment.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyDetailQueryClause.md b/build/docs/SurveyDetailQueryClause.md index 9f73a3d1b..e69dad105 100644 --- a/build/docs/SurveyDetailQueryClause.md +++ b/build/docs/SurveyDetailQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyDetailQueryFilter.md b/build/docs/SurveyDetailQueryFilter.md index ac1479a1f..6d36d6f71 100644 --- a/build/docs/SurveyDetailQueryFilter.md +++ b/build/docs/SurveyDetailQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyDetailQueryPredicate.md b/build/docs/SurveyDetailQueryPredicate.md index 9c9e551ba..f37513b94 100644 --- a/build/docs/SurveyDetailQueryPredicate.md +++ b/build/docs/SurveyDetailQueryPredicate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyErrorDetails.md b/build/docs/SurveyErrorDetails.md index 35aed4688..cb9586c67 100644 --- a/build/docs/SurveyErrorDetails.md +++ b/build/docs/SurveyErrorDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyForm.md b/build/docs/SurveyForm.md index 8ffdf3459..f5532c969 100644 --- a/build/docs/SurveyForm.md +++ b/build/docs/SurveyForm.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyFormAndScoringSet.md b/build/docs/SurveyFormAndScoringSet.md index f5c680f33..4711a23e3 100644 --- a/build/docs/SurveyFormAndScoringSet.md +++ b/build/docs/SurveyFormAndScoringSet.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyFormEntityListing.md b/build/docs/SurveyFormEntityListing.md index c00a11d94..553ac825e 100644 --- a/build/docs/SurveyFormEntityListing.md +++ b/build/docs/SurveyFormEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyQuestion.md b/build/docs/SurveyQuestion.md index 9a7a21d1e..3d7a2c0c0 100644 --- a/build/docs/SurveyQuestion.md +++ b/build/docs/SurveyQuestion.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyQuestionGroup.md b/build/docs/SurveyQuestionGroup.md index 11dfc84b1..dc482a48f 100644 --- a/build/docs/SurveyQuestionGroup.md +++ b/build/docs/SurveyQuestionGroup.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyQuestionGroupScore.md b/build/docs/SurveyQuestionGroupScore.md index a0ae86e3e..212a5dbbd 100644 --- a/build/docs/SurveyQuestionGroupScore.md +++ b/build/docs/SurveyQuestionGroupScore.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyQuestionScore.md b/build/docs/SurveyQuestionScore.md index 63cc8fb1c..097bf5ffa 100644 --- a/build/docs/SurveyQuestionScore.md +++ b/build/docs/SurveyQuestionScore.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SurveyScoringSet.md b/build/docs/SurveyScoringSet.md index c78fc551a..e9896bf20 100644 --- a/build/docs/SurveyScoringSet.md +++ b/build/docs/SurveyScoringSet.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SyncStatusRequest.md b/build/docs/SyncStatusRequest.md index 67f72911a..6ef109093 100644 --- a/build/docs/SyncStatusRequest.md +++ b/build/docs/SyncStatusRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SystemMessageObject.md b/build/docs/SystemMessageObject.md index 0983176b0..172307220 100644 --- a/build/docs/SystemMessageObject.md +++ b/build/docs/SystemMessageObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SystemMessageSystemMessage.md b/build/docs/SystemMessageSystemMessage.md index 11356ba1b..c6e9da9b2 100644 --- a/build/docs/SystemMessageSystemMessage.md +++ b/build/docs/SystemMessageSystemMessage.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SystemPresence.md b/build/docs/SystemPresence.md index 30ddbf7a0..1d10aa58c 100644 --- a/build/docs/SystemPresence.md +++ b/build/docs/SystemPresence.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SystemPrompt.md b/build/docs/SystemPrompt.md index 46f957c91..7dcd0a038 100644 --- a/build/docs/SystemPrompt.md +++ b/build/docs/SystemPrompt.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SystemPromptAsset.md b/build/docs/SystemPromptAsset.md index 28dcf2c53..ceb8fe1d8 100644 --- a/build/docs/SystemPromptAsset.md +++ b/build/docs/SystemPromptAsset.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SystemPromptAssetEntityListing.md b/build/docs/SystemPromptAssetEntityListing.md index 56133b1b7..9edde8328 100644 --- a/build/docs/SystemPromptAssetEntityListing.md +++ b/build/docs/SystemPromptAssetEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/SystemPromptEntityListing.md b/build/docs/SystemPromptEntityListing.md index 4247f192a..50c93131d 100644 --- a/build/docs/SystemPromptEntityListing.md +++ b/build/docs/SystemPromptEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TagQueryRequest.md b/build/docs/TagQueryRequest.md index 0f39ef2fc..0fee56083 100644 --- a/build/docs/TagQueryRequest.md +++ b/build/docs/TagQueryRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TagValue.md b/build/docs/TagValue.md index 916749156..5c462c04e 100644 --- a/build/docs/TagValue.md +++ b/build/docs/TagValue.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TagValueEntityListing.md b/build/docs/TagValueEntityListing.md index 143fb4d9a..350989d5e 100644 --- a/build/docs/TagValueEntityListing.md +++ b/build/docs/TagValueEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TargetPerformanceProfile.md b/build/docs/TargetPerformanceProfile.md index 5d63db346..f48f16754 100644 --- a/build/docs/TargetPerformanceProfile.md +++ b/build/docs/TargetPerformanceProfile.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementAPI.md b/build/docs/TaskManagementAPI.md index 89dc4ccd7..02f10c17f 100644 --- a/build/docs/TaskManagementAPI.md +++ b/build/docs/TaskManagementAPI.md @@ -965,7 +965,7 @@ TaskManagementAPI.getTaskmanagementWorktype(worktypeId: worktypeId, expands: exp | Name | Type | Description | Notes | | ------------- | ------------- | ------------- | ------------- | | **worktypeId** | **String**| Worktype id | | -| **expands** | [**[String]**](String)| Which fields, if any, to expand. | [optional]
**Values**: defaultqueue ("defaultQueue"), defaultskills ("defaultSkills"), defaultlanguage ("defaultLanguage"), schema ("schema"), flow ("flow") | +| **expands** | [**[String]**](String)| Which fields, if any, to expand. | [optional]
**Values**: defaultqueue ("defaultQueue"), defaultskills ("defaultSkills"), defaultlanguage ("defaultLanguage"), schema ("schema"), flow ("flow"), defaultscript ("defaultScript") | ### Return type @@ -2474,4 +2474,4 @@ TaskManagementAPI.putTaskmanagementWorkitemsSchema(schemaId: schemaId, body: bod [**DataSchema**](DataSchema) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementAggregateDataContainer.md b/build/docs/TaskManagementAggregateDataContainer.md index e4a1be76a..44eeab860 100644 --- a/build/docs/TaskManagementAggregateDataContainer.md +++ b/build/docs/TaskManagementAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementAggregateQueryClause.md b/build/docs/TaskManagementAggregateQueryClause.md index 78d963c8c..811c7833f 100644 --- a/build/docs/TaskManagementAggregateQueryClause.md +++ b/build/docs/TaskManagementAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementAggregateQueryFilter.md b/build/docs/TaskManagementAggregateQueryFilter.md index b129cd0fa..7dfad8225 100644 --- a/build/docs/TaskManagementAggregateQueryFilter.md +++ b/build/docs/TaskManagementAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementAggregateQueryPredicate.md b/build/docs/TaskManagementAggregateQueryPredicate.md index 27b0b7e81..80af1ee78 100644 --- a/build/docs/TaskManagementAggregateQueryPredicate.md +++ b/build/docs/TaskManagementAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementAggregateQueryResponse.md b/build/docs/TaskManagementAggregateQueryResponse.md index 275075d09..8582e6b46 100644 --- a/build/docs/TaskManagementAggregateQueryResponse.md +++ b/build/docs/TaskManagementAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementAggregationQuery.md b/build/docs/TaskManagementAggregationQuery.md index 526b90d93..22fe11ea9 100644 --- a/build/docs/TaskManagementAggregationQuery.md +++ b/build/docs/TaskManagementAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementAggregationView.md b/build/docs/TaskManagementAggregationView.md index 1c5af8aed..ebf1432a4 100644 --- a/build/docs/TaskManagementAggregationView.md +++ b/build/docs/TaskManagementAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TaskManagementErrorDetails.md b/build/docs/TaskManagementErrorDetails.md index 33cd1a09b..69804087e 100644 --- a/build/docs/TaskManagementErrorDetails.md +++ b/build/docs/TaskManagementErrorDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Team.md b/build/docs/Team.md index 795748f77..c9509d5d0 100644 --- a/build/docs/Team.md +++ b/build/docs/Team.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityData.md b/build/docs/TeamActivityData.md index dd4a43716..d3d5cbdca 100644 --- a/build/docs/TeamActivityData.md +++ b/build/docs/TeamActivityData.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityEntityData.md b/build/docs/TeamActivityEntityData.md index 5ea78708c..293147c8f 100644 --- a/build/docs/TeamActivityEntityData.md +++ b/build/docs/TeamActivityEntityData.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityMetricValue.md b/build/docs/TeamActivityMetricValue.md index 07c3e5391..940befc65 100644 --- a/build/docs/TeamActivityMetricValue.md +++ b/build/docs/TeamActivityMetricValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityQuery.md b/build/docs/TeamActivityQuery.md index d50677b60..6066ff81c 100644 --- a/build/docs/TeamActivityQuery.md +++ b/build/docs/TeamActivityQuery.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityQueryClause.md b/build/docs/TeamActivityQueryClause.md index de2a7afa9..76629b616 100644 --- a/build/docs/TeamActivityQueryClause.md +++ b/build/docs/TeamActivityQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityQueryFilter.md b/build/docs/TeamActivityQueryFilter.md index 3894ab5e1..7e0f600cc 100644 --- a/build/docs/TeamActivityQueryFilter.md +++ b/build/docs/TeamActivityQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityQueryMetric.md b/build/docs/TeamActivityQueryMetric.md index 07a18cd28..374d31785 100644 --- a/build/docs/TeamActivityQueryMetric.md +++ b/build/docs/TeamActivityQueryMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityQueryPredicate.md b/build/docs/TeamActivityQueryPredicate.md index 99db4eb4f..b202f7c1b 100644 --- a/build/docs/TeamActivityQueryPredicate.md +++ b/build/docs/TeamActivityQueryPredicate.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamActivityResponse.md b/build/docs/TeamActivityResponse.md index bd848c613..579035483 100644 --- a/build/docs/TeamActivityResponse.md +++ b/build/docs/TeamActivityResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamAddMemberFailure.md b/build/docs/TeamAddMemberFailure.md index be6cd753a..a9a2e5a31 100644 --- a/build/docs/TeamAddMemberFailure.md +++ b/build/docs/TeamAddMemberFailure.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamEntityListing.md b/build/docs/TeamEntityListing.md index 4d6d12b59..fb2f6629e 100644 --- a/build/docs/TeamEntityListing.md +++ b/build/docs/TeamEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamMemberAddListingResponse.md b/build/docs/TeamMemberAddListingResponse.md index 0abdbe259..4e05ce0e1 100644 --- a/build/docs/TeamMemberAddListingResponse.md +++ b/build/docs/TeamMemberAddListingResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamMemberEntityListing.md b/build/docs/TeamMemberEntityListing.md index b5a948f7f..08a31c392 100644 --- a/build/docs/TeamMemberEntityListing.md +++ b/build/docs/TeamMemberEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamMembers.md b/build/docs/TeamMembers.md index cb6200ed5..022435dd8 100644 --- a/build/docs/TeamMembers.md +++ b/build/docs/TeamMembers.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamReference.md b/build/docs/TeamReference.md index 28b2c40fc..266351b9e 100644 --- a/build/docs/TeamReference.md +++ b/build/docs/TeamReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamSearchCriteria.md b/build/docs/TeamSearchCriteria.md index a95ca6baa..25df4542c 100644 --- a/build/docs/TeamSearchCriteria.md +++ b/build/docs/TeamSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamSearchRequest.md b/build/docs/TeamSearchRequest.md index 4e6a882e3..c2143ce9b 100644 --- a/build/docs/TeamSearchRequest.md +++ b/build/docs/TeamSearchRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamsAPI.md b/build/docs/TeamsAPI.md index e5aa3d965..826f41b64 100644 --- a/build/docs/TeamsAPI.md +++ b/build/docs/TeamsAPI.md @@ -543,4 +543,4 @@ TeamsAPI.postTeamsSearch(body: body) { (response, error) in [**TeamsSearchResponse**](TeamsSearchResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TeamsSearchResponse.md b/build/docs/TeamsSearchResponse.md index c3783b589..17139cae1 100644 --- a/build/docs/TeamsSearchResponse.md +++ b/build/docs/TeamsSearchResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TelephonyAPI.md b/build/docs/TelephonyAPI.md index bdae9ee80..20efd9999 100644 --- a/build/docs/TelephonyAPI.md +++ b/build/docs/TelephonyAPI.md @@ -327,4 +327,4 @@ TelephonyAPI.postTelephonySiptracesDownload(sIPSearchPublicRequest: sIPSearchPub [**SipDownloadResponse**](SipDownloadResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TelephonyProvidersEdgeAPI.md b/build/docs/TelephonyProvidersEdgeAPI.md index b119af400..0b04d3ee7 100644 --- a/build/docs/TelephonyProvidersEdgeAPI.md +++ b/build/docs/TelephonyProvidersEdgeAPI.md @@ -6577,4 +6577,4 @@ TelephonyProvidersEdgeAPI.putTelephonyProvidersEdgesTrunkbasesetting(trunkBaseSe [**TrunkBase**](TrunkBase) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TemplateParameter.md b/build/docs/TemplateParameter.md index 05f87618b..6b0c0553b 100644 --- a/build/docs/TemplateParameter.md +++ b/build/docs/TemplateParameter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Term.md b/build/docs/Term.md index 4c89c9d8b..b3c6019e9 100644 --- a/build/docs/Term.md +++ b/build/docs/Term.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TermAttribute.md b/build/docs/TermAttribute.md index 3a0d9e47c..7b71d6fba 100644 --- a/build/docs/TermAttribute.md +++ b/build/docs/TermAttribute.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestExecutionOperationResult.md b/build/docs/TestExecutionOperationResult.md index ec0dc4615..934b55e57 100644 --- a/build/docs/TestExecutionOperationResult.md +++ b/build/docs/TestExecutionOperationResult.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestExecutionResult.md b/build/docs/TestExecutionResult.md index 25d1bbfa1..b4f3e6f74 100644 --- a/build/docs/TestExecutionResult.md +++ b/build/docs/TestExecutionResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestMatchesEventOperation.md b/build/docs/TestMatchesEventOperation.md index a2e49c31d..2cc0558d3 100644 --- a/build/docs/TestMatchesEventOperation.md +++ b/build/docs/TestMatchesEventOperation.md @@ -14,4 +14,4 @@ Results from evaluating matching criteria against test input -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestMatchesOperation.md b/build/docs/TestMatchesOperation.md index e617b6f50..3550dbbb4 100644 --- a/build/docs/TestMatchesOperation.md +++ b/build/docs/TestMatchesOperation.md @@ -14,4 +14,4 @@ Information about the Trigger test mode processing step -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestMessage.md b/build/docs/TestMessage.md index 2c1e896fc..22d9f8ce2 100644 --- a/build/docs/TestMessage.md +++ b/build/docs/TestMessage.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestModeEventResults.md b/build/docs/TestModeEventResults.md index 640b7e3d7..f090951cd 100644 --- a/build/docs/TestModeEventResults.md +++ b/build/docs/TestModeEventResults.md @@ -12,4 +12,4 @@ Information about event test mode execution -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestModeResults.md b/build/docs/TestModeResults.md index 55d308620..26f45c95a 100644 --- a/build/docs/TestModeResults.md +++ b/build/docs/TestModeResults.md @@ -14,4 +14,4 @@ Information about trigger test mode execution -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestModeTrigger.md b/build/docs/TestModeTrigger.md index 29bd5040e..d23514224 100644 --- a/build/docs/TestModeTrigger.md +++ b/build/docs/TestModeTrigger.md @@ -14,4 +14,4 @@ Basic identifying information about a trigger -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestSchemaOperation.md b/build/docs/TestSchemaOperation.md index e845d24d5..3e6fa1915 100644 --- a/build/docs/TestSchemaOperation.md +++ b/build/docs/TestSchemaOperation.md @@ -14,4 +14,4 @@ Information about the Trigger test mode schema validation step -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TestTargetOperation.md b/build/docs/TestTargetOperation.md index af6368e0f..065b18c0f 100644 --- a/build/docs/TestTargetOperation.md +++ b/build/docs/TestTargetOperation.md @@ -14,4 +14,4 @@ Information about the Trigger test mode target validation step -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotChannel.md b/build/docs/TextBotChannel.md index bb32b7086..b3f193944 100644 --- a/build/docs/TextBotChannel.md +++ b/build/docs/TextBotChannel.md @@ -14,4 +14,4 @@ Channel information relevant to a bot flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotDisconnectAction.md b/build/docs/TextBotDisconnectAction.md index 39c9440f0..0beac2dbc 100644 --- a/build/docs/TextBotDisconnectAction.md +++ b/build/docs/TextBotDisconnectAction.md @@ -14,4 +14,4 @@ Settings for a next-action of disconnecting, including the reason code for the d -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotErrorInputEvent.md b/build/docs/TextBotErrorInputEvent.md index 590e6dcb4..5aca91b26 100644 --- a/build/docs/TextBotErrorInputEvent.md +++ b/build/docs/TextBotErrorInputEvent.md @@ -12,4 +12,4 @@ Settings for an input event to the bot flow indicating an error has occurred. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotExitAction.md b/build/docs/TextBotExitAction.md index 0069449da..3226fa9e2 100644 --- a/build/docs/TextBotExitAction.md +++ b/build/docs/TextBotExitAction.md @@ -16,4 +16,4 @@ Settings for a next-action of exiting the bot flow. Any output variables are ava -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotFlow.md b/build/docs/TextBotFlow.md index 1cd7ccfe1..f523ff868 100644 --- a/build/docs/TextBotFlow.md +++ b/build/docs/TextBotFlow.md @@ -11,4 +11,4 @@ Description of the Bot Flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotFlowLaunchRequest.md b/build/docs/TextBotFlowLaunchRequest.md index 531077299..5143cc468 100644 --- a/build/docs/TextBotFlowLaunchRequest.md +++ b/build/docs/TextBotFlowLaunchRequest.md @@ -16,4 +16,4 @@ Settings for launching an instance of a bot flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotFlowLaunchResponse.md b/build/docs/TextBotFlowLaunchResponse.md index 94ce1b785..6ff094f40 100644 --- a/build/docs/TextBotFlowLaunchResponse.md +++ b/build/docs/TextBotFlowLaunchResponse.md @@ -11,4 +11,4 @@ Information related to a successful launch of a bot flow. The ID will be used in -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotFlowLocation.md b/build/docs/TextBotFlowLocation.md index e5dfe7a6a..0354c552f 100644 --- a/build/docs/TextBotFlowLocation.md +++ b/build/docs/TextBotFlowLocation.md @@ -13,4 +13,4 @@ Describes a flow location. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotFlowMilestone.md b/build/docs/TextBotFlowMilestone.md index 6755c2db7..3d360bd4c 100644 --- a/build/docs/TextBotFlowMilestone.md +++ b/build/docs/TextBotFlowMilestone.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotFlowOutcome.md b/build/docs/TextBotFlowOutcome.md index 32d38b4d3..04c423f22 100644 --- a/build/docs/TextBotFlowOutcome.md +++ b/build/docs/TextBotFlowOutcome.md @@ -15,4 +15,4 @@ Flow Outcome data related to a bot flow which is exiting gracefully. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotFlowTurnRequest.md b/build/docs/TextBotFlowTurnRequest.md index ea68705aa..386b4dde8 100644 --- a/build/docs/TextBotFlowTurnRequest.md +++ b/build/docs/TextBotFlowTurnRequest.md @@ -14,4 +14,4 @@ Settings for a turn request to a bot flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotFlowTurnResponse.md b/build/docs/TextBotFlowTurnResponse.md index 7af1d40aa..f286300ae 100644 --- a/build/docs/TextBotFlowTurnResponse.md +++ b/build/docs/TextBotFlowTurnResponse.md @@ -17,4 +17,4 @@ Information related to a success bot flow turn request. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotInputOutputData.md b/build/docs/TextBotInputOutputData.md index 46c9b3f97..682c6ddb2 100644 --- a/build/docs/TextBotInputOutputData.md +++ b/build/docs/TextBotInputOutputData.md @@ -11,4 +11,4 @@ Input/Output data related to a bot flow which is exiting gracefully. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotModeConstraints.md b/build/docs/TextBotModeConstraints.md index bee9f28e7..fcea055cc 100644 --- a/build/docs/TextBotModeConstraints.md +++ b/build/docs/TextBotModeConstraints.md @@ -11,4 +11,4 @@ Mode constraints to observe when operating on a bot flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotModeOutputPrompts.md b/build/docs/TextBotModeOutputPrompts.md index 8a56c7950..9fde93e65 100644 --- a/build/docs/TextBotModeOutputPrompts.md +++ b/build/docs/TextBotModeOutputPrompts.md @@ -11,4 +11,4 @@ Prompt information related to a bot flow turn. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotOutputPrompts.md b/build/docs/TextBotOutputPrompts.md index 79a2b2f73..5f2a0d4b7 100644 --- a/build/docs/TextBotOutputPrompts.md +++ b/build/docs/TextBotOutputPrompts.md @@ -12,4 +12,4 @@ Prompt information related to a bot flow turn. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotPromptSegment.md b/build/docs/TextBotPromptSegment.md index 1b42028ea..72e4192c5 100644 --- a/build/docs/TextBotPromptSegment.md +++ b/build/docs/TextBotPromptSegment.md @@ -14,4 +14,4 @@ Data for a single bot flow prompt segment. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotTextModeConstraints.md b/build/docs/TextBotTextModeConstraints.md index 8918445fb..61bb5822f 100644 --- a/build/docs/TextBotTextModeConstraints.md +++ b/build/docs/TextBotTextModeConstraints.md @@ -12,4 +12,4 @@ Mode constraints to observe when operating on a bot flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotTranscript.md b/build/docs/TextBotTranscript.md index 3fe4ef818..a9a13dae9 100644 --- a/build/docs/TextBotTranscript.md +++ b/build/docs/TextBotTranscript.md @@ -12,4 +12,4 @@ Data for a single bot flow transcript. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotTurnReference.md b/build/docs/TextBotTurnReference.md index 29f98cc90..e1e2755e6 100644 --- a/build/docs/TextBotTurnReference.md +++ b/build/docs/TextBotTurnReference.md @@ -11,4 +11,4 @@ A reference to a bot flow turn. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotUserAgent.md b/build/docs/TextBotUserAgent.md index e891f1948..fbac3b7e9 100644 --- a/build/docs/TextBotUserAgent.md +++ b/build/docs/TextBotUserAgent.md @@ -11,4 +11,4 @@ Information about the caller executing a bot flow. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotUserInputAlternative.md b/build/docs/TextBotUserInputAlternative.md index 48abae69f..c8df91170 100644 --- a/build/docs/TextBotUserInputAlternative.md +++ b/build/docs/TextBotUserInputAlternative.md @@ -11,4 +11,4 @@ User input data used in a bot flow turn. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotUserInputEvent.md b/build/docs/TextBotUserInputEvent.md index 78a618399..ec84e66bc 100644 --- a/build/docs/TextBotUserInputEvent.md +++ b/build/docs/TextBotUserInputEvent.md @@ -12,4 +12,4 @@ Settings for an input event to the bot flow indicating user input is available. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextBotWaitForInputAction.md b/build/docs/TextBotWaitForInputAction.md index 25151e93f..c326e934c 100644 --- a/build/docs/TextBotWaitForInputAction.md +++ b/build/docs/TextBotWaitForInputAction.md @@ -11,4 +11,4 @@ Settings for a next-action of waiting for additional user input and sending the -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextMessageListing.md b/build/docs/TextMessageListing.md index c63a2033d..f6b9f313e 100644 --- a/build/docs/TextMessageListing.md +++ b/build/docs/TextMessageListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextStyleProperties.md b/build/docs/TextStyleProperties.md index 220a0c359..68c5157f7 100644 --- a/build/docs/TextStyleProperties.md +++ b/build/docs/TextStyleProperties.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TextbotsAPI.md b/build/docs/TextbotsAPI.md index 7d98020ec..be6f1dd29 100644 --- a/build/docs/TextbotsAPI.md +++ b/build/docs/TextbotsAPI.md @@ -227,4 +227,4 @@ TextbotsAPI.postTextbotsBotsExecute(postTextRequest: postTextRequest) { (respons [**PostTextResponse**](PostTextResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Ticker.md b/build/docs/Ticker.md index 09621e47a..b77ac4d81 100644 --- a/build/docs/Ticker.md +++ b/build/docs/Ticker.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeAllowed.md b/build/docs/TimeAllowed.md index c5e9902a5..cd885e146 100644 --- a/build/docs/TimeAllowed.md +++ b/build/docs/TimeAllowed.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeInterval.md b/build/docs/TimeInterval.md index 5aa774d86..1dcd2b603 100644 --- a/build/docs/TimeInterval.md +++ b/build/docs/TimeInterval.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffBalanceJobReference.md b/build/docs/TimeOffBalanceJobReference.md index 969a4e4bb..e89bff30b 100644 --- a/build/docs/TimeOffBalanceJobReference.md +++ b/build/docs/TimeOffBalanceJobReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffBalanceJobResponse.md b/build/docs/TimeOffBalanceJobResponse.md index ae472364a..f381015d8 100644 --- a/build/docs/TimeOffBalanceJobResponse.md +++ b/build/docs/TimeOffBalanceJobResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffBalanceRequest.md b/build/docs/TimeOffBalanceRequest.md index f7145b83f..f45653e4f 100644 --- a/build/docs/TimeOffBalanceRequest.md +++ b/build/docs/TimeOffBalanceRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffBalanceResponse.md b/build/docs/TimeOffBalanceResponse.md index 2489e44cc..4e5b34b7f 100644 --- a/build/docs/TimeOffBalanceResponse.md +++ b/build/docs/TimeOffBalanceResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffBalancesResponse.md b/build/docs/TimeOffBalancesResponse.md index ec4f4576c..9da78b534 100644 --- a/build/docs/TimeOffBalancesResponse.md +++ b/build/docs/TimeOffBalancesResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffIntegrationStatusResponse.md b/build/docs/TimeOffIntegrationStatusResponse.md index 73d623c5f..e00d4db22 100644 --- a/build/docs/TimeOffIntegrationStatusResponse.md +++ b/build/docs/TimeOffIntegrationStatusResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffIntegrationStatusResponseListing.md b/build/docs/TimeOffIntegrationStatusResponseListing.md index 2cd35b920..3236730ba 100644 --- a/build/docs/TimeOffIntegrationStatusResponseListing.md +++ b/build/docs/TimeOffIntegrationStatusResponseListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffLimit.md b/build/docs/TimeOffLimit.md index 36049e819..1d4a3b11e 100644 --- a/build/docs/TimeOffLimit.md +++ b/build/docs/TimeOffLimit.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffLimitListing.md b/build/docs/TimeOffLimitListing.md index 0c9688084..b2bbf5514 100644 --- a/build/docs/TimeOffLimitListing.md +++ b/build/docs/TimeOffLimitListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffLimitRange.md b/build/docs/TimeOffLimitRange.md index 7da9c7de4..baece8d2a 100644 --- a/build/docs/TimeOffLimitRange.md +++ b/build/docs/TimeOffLimitRange.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffLimitReference.md b/build/docs/TimeOffLimitReference.md index cd8754f10..ec24aefe2 100644 --- a/build/docs/TimeOffLimitReference.md +++ b/build/docs/TimeOffLimitReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffLimitValueRange.md b/build/docs/TimeOffLimitValueRange.md index 9c84b6c7f..1bc3c29dd 100644 --- a/build/docs/TimeOffLimitValueRange.md +++ b/build/docs/TimeOffLimitValueRange.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffPlan.md b/build/docs/TimeOffPlan.md index f4b415d27..cdfafdafd 100644 --- a/build/docs/TimeOffPlan.md +++ b/build/docs/TimeOffPlan.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffPlanBusinessUnitAssociation.md b/build/docs/TimeOffPlanBusinessUnitAssociation.md index fd8caa745..f3cfa1591 100644 --- a/build/docs/TimeOffPlanBusinessUnitAssociation.md +++ b/build/docs/TimeOffPlanBusinessUnitAssociation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffPlanListing.md b/build/docs/TimeOffPlanListing.md index 7b0bc53fb..11006fc36 100644 --- a/build/docs/TimeOffPlanListing.md +++ b/build/docs/TimeOffPlanListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffPlanManagementUnitAssociation.md b/build/docs/TimeOffPlanManagementUnitAssociation.md index 01fe08c86..c8103fbe2 100644 --- a/build/docs/TimeOffPlanManagementUnitAssociation.md +++ b/build/docs/TimeOffPlanManagementUnitAssociation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequest.md b/build/docs/TimeOffRequest.md index f7effdb0a..30537bac7 100644 --- a/build/docs/TimeOffRequest.md +++ b/build/docs/TimeOffRequest.md @@ -30,4 +30,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequestList.md b/build/docs/TimeOffRequestList.md index b423a69c1..99a4756ee 100644 --- a/build/docs/TimeOffRequestList.md +++ b/build/docs/TimeOffRequestList.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequestListing.md b/build/docs/TimeOffRequestListing.md index 2dbf0535b..1a0513484 100644 --- a/build/docs/TimeOffRequestListing.md +++ b/build/docs/TimeOffRequestListing.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequestLookup.md b/build/docs/TimeOffRequestLookup.md index dbe91a24a..1b3d66d62 100644 --- a/build/docs/TimeOffRequestLookup.md +++ b/build/docs/TimeOffRequestLookup.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequestNotification.md b/build/docs/TimeOffRequestNotification.md index 8f4521aa4..4f1a64a5c 100644 --- a/build/docs/TimeOffRequestNotification.md +++ b/build/docs/TimeOffRequestNotification.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequestQueryBody.md b/build/docs/TimeOffRequestQueryBody.md index 3e73dc066..1d794d175 100644 --- a/build/docs/TimeOffRequestQueryBody.md +++ b/build/docs/TimeOffRequestQueryBody.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequestReference.md b/build/docs/TimeOffRequestReference.md index 165e49ccb..07d2e396b 100644 --- a/build/docs/TimeOffRequestReference.md +++ b/build/docs/TimeOffRequestReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequestResponse.md b/build/docs/TimeOffRequestResponse.md index 65e3e03fa..fc7af8753 100644 --- a/build/docs/TimeOffRequestResponse.md +++ b/build/docs/TimeOffRequestResponse.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeOffRequestSettings.md b/build/docs/TimeOffRequestSettings.md index fc8c0c1a4..66b6c8229 100644 --- a/build/docs/TimeOffRequestSettings.md +++ b/build/docs/TimeOffRequestSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeSlot.md b/build/docs/TimeSlot.md index 376875a2f..17a293e7b 100644 --- a/build/docs/TimeSlot.md +++ b/build/docs/TimeSlot.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeZoneEntityListing.md b/build/docs/TimeZoneEntityListing.md index b83cc7f6a..64180b5bf 100644 --- a/build/docs/TimeZoneEntityListing.md +++ b/build/docs/TimeZoneEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TimeZoneMappingPreview.md b/build/docs/TimeZoneMappingPreview.md index 86914b0f1..b6c909e60 100644 --- a/build/docs/TimeZoneMappingPreview.md +++ b/build/docs/TimeZoneMappingPreview.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TokenInfo.md b/build/docs/TokenInfo.md index cd11c2963..5cf61df9a 100644 --- a/build/docs/TokenInfo.md +++ b/build/docs/TokenInfo.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TokenInfoClonedUser.md b/build/docs/TokenInfoClonedUser.md index 6809ac634..daa3da27b 100644 --- a/build/docs/TokenInfoClonedUser.md +++ b/build/docs/TokenInfoClonedUser.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TokensAPI.md b/build/docs/TokensAPI.md index 95330d5fa..14522eb11 100644 --- a/build/docs/TokensAPI.md +++ b/build/docs/TokensAPI.md @@ -294,4 +294,4 @@ TokensAPI.putTokensTimeout(body: body) { (response, error) in [**IdleTokenTimeout**](IdleTokenTimeout) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Topic.md b/build/docs/Topic.md index 991c729c5..571852ce5 100644 --- a/build/docs/Topic.md +++ b/build/docs/Topic.md @@ -24,4 +24,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TopicCursorEntityListing.md b/build/docs/TopicCursorEntityListing.md index e25d0f54c..39b4ab66f 100644 --- a/build/docs/TopicCursorEntityListing.md +++ b/build/docs/TopicCursorEntityListing.md @@ -14,4 +14,4 @@ Cursor listing of Topics. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TopicDuration.md b/build/docs/TopicDuration.md index 8d59216ce..2839bba4d 100644 --- a/build/docs/TopicDuration.md +++ b/build/docs/TopicDuration.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TopicJob.md b/build/docs/TopicJob.md index db7dbb847..969909ca8 100644 --- a/build/docs/TopicJob.md +++ b/build/docs/TopicJob.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TopicJobRequest.md b/build/docs/TopicJobRequest.md index e233b7d46..a3fa58ba2 100644 --- a/build/docs/TopicJobRequest.md +++ b/build/docs/TopicJobRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TopicOffset.md b/build/docs/TopicOffset.md index 68c046e26..001f8bf93 100644 --- a/build/docs/TopicOffset.md +++ b/build/docs/TopicOffset.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TopicPhrase.md b/build/docs/TopicPhrase.md index 25b6cbee1..774707ca8 100644 --- a/build/docs/TopicPhrase.md +++ b/build/docs/TopicPhrase.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TopicRequest.md b/build/docs/TopicRequest.md index 11673fdfd..a577b9746 100644 --- a/build/docs/TopicRequest.md +++ b/build/docs/TopicRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TopicsEntityListing.md b/build/docs/TopicsEntityListing.md index 507aaea1e..0fe4a5791 100644 --- a/build/docs/TopicsEntityListing.md +++ b/build/docs/TopicsEntityListing.md @@ -9,10 +9,10 @@ | **entities** | [**[ListedTopic]**](ListedTopic) | | [optional] | | **pageSize** | **Int** | | [optional] | | **total** | **Int** | | [optional] | -| **nextUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrainingListing.md b/build/docs/TrainingListing.md index 00edcdfda..3496407b6 100644 --- a/build/docs/TrainingListing.md +++ b/build/docs/TrainingListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptAggregateDataContainer.md b/build/docs/TranscriptAggregateDataContainer.md index 5af5811ba..36485e323 100644 --- a/build/docs/TranscriptAggregateDataContainer.md +++ b/build/docs/TranscriptAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptAggregateQueryClause.md b/build/docs/TranscriptAggregateQueryClause.md index 1e3433a18..7f32907cd 100644 --- a/build/docs/TranscriptAggregateQueryClause.md +++ b/build/docs/TranscriptAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptAggregateQueryFilter.md b/build/docs/TranscriptAggregateQueryFilter.md index 523670ed7..78a9a4a82 100644 --- a/build/docs/TranscriptAggregateQueryFilter.md +++ b/build/docs/TranscriptAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptAggregateQueryPredicate.md b/build/docs/TranscriptAggregateQueryPredicate.md index b08de37c7..9b2b6347b 100644 --- a/build/docs/TranscriptAggregateQueryPredicate.md +++ b/build/docs/TranscriptAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptAggregateQueryResponse.md b/build/docs/TranscriptAggregateQueryResponse.md index 88aeff042..aa3280e90 100644 --- a/build/docs/TranscriptAggregateQueryResponse.md +++ b/build/docs/TranscriptAggregateQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptAggregationQuery.md b/build/docs/TranscriptAggregationQuery.md index 943c3795a..dd4c8c0b0 100644 --- a/build/docs/TranscriptAggregationQuery.md +++ b/build/docs/TranscriptAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptAggregationView.md b/build/docs/TranscriptAggregationView.md index 70b1161d5..900f64eed 100644 --- a/build/docs/TranscriptAggregationView.md +++ b/build/docs/TranscriptAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptConversationDetailSearchCriteria.md b/build/docs/TranscriptConversationDetailSearchCriteria.md index ad739980e..111a8a066 100644 --- a/build/docs/TranscriptConversationDetailSearchCriteria.md +++ b/build/docs/TranscriptConversationDetailSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptConversationDetailSearchRequest.md b/build/docs/TranscriptConversationDetailSearchRequest.md index 7f8f983f5..63f4bf648 100644 --- a/build/docs/TranscriptConversationDetailSearchRequest.md +++ b/build/docs/TranscriptConversationDetailSearchRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptSearchCriteria.md b/build/docs/TranscriptSearchCriteria.md index ce0fc4bc6..45094cb9e 100644 --- a/build/docs/TranscriptSearchCriteria.md +++ b/build/docs/TranscriptSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptSearchRequest.md b/build/docs/TranscriptSearchRequest.md index 6e249e403..34bcb2d09 100644 --- a/build/docs/TranscriptSearchRequest.md +++ b/build/docs/TranscriptSearchRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptTopic.md b/build/docs/TranscriptTopic.md index 57ea1aaaf..ef2ee628d 100644 --- a/build/docs/TranscriptTopic.md +++ b/build/docs/TranscriptTopic.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptTopics.md b/build/docs/TranscriptTopics.md index 1c1c9ccc2..baef2f965 100644 --- a/build/docs/TranscriptTopics.md +++ b/build/docs/TranscriptTopics.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptUrl.md b/build/docs/TranscriptUrl.md index 5d4178a06..7c882c26d 100644 --- a/build/docs/TranscriptUrl.md +++ b/build/docs/TranscriptUrl.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptUrls.md b/build/docs/TranscriptUrls.md index 718b8ea83..e480617e6 100644 --- a/build/docs/TranscriptUrls.md +++ b/build/docs/TranscriptUrls.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptionConfig.md b/build/docs/TranscriptionConfig.md index 50e54feb2..012c434d3 100644 --- a/build/docs/TranscriptionConfig.md +++ b/build/docs/TranscriptionConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptionEnginesRequest.md b/build/docs/TranscriptionEnginesRequest.md index 4a096c6a6..f0819e746 100644 --- a/build/docs/TranscriptionEnginesRequest.md +++ b/build/docs/TranscriptionEnginesRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptionSettings.md b/build/docs/TranscriptionSettings.md index 2c1c788e4..c8789a04a 100644 --- a/build/docs/TranscriptionSettings.md +++ b/build/docs/TranscriptionSettings.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptionTopicTranscriptAlternative.md b/build/docs/TranscriptionTopicTranscriptAlternative.md index 7cafa19a0..bc0a1daba 100644 --- a/build/docs/TranscriptionTopicTranscriptAlternative.md +++ b/build/docs/TranscriptionTopicTranscriptAlternative.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptionTopicTranscriptResult.md b/build/docs/TranscriptionTopicTranscriptResult.md index 8776dbbe8..346095fe7 100644 --- a/build/docs/TranscriptionTopicTranscriptResult.md +++ b/build/docs/TranscriptionTopicTranscriptResult.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptionTopicTranscriptWord.md b/build/docs/TranscriptionTopicTranscriptWord.md index 27ce5de37..9881f1a61 100644 --- a/build/docs/TranscriptionTopicTranscriptWord.md +++ b/build/docs/TranscriptionTopicTranscriptWord.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptionTopicTranscriptionMessage.md b/build/docs/TranscriptionTopicTranscriptionMessage.md index f3328dce4..eb42dfd12 100644 --- a/build/docs/TranscriptionTopicTranscriptionMessage.md +++ b/build/docs/TranscriptionTopicTranscriptionMessage.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TranscriptionTopicTranscriptionRequestStatus.md b/build/docs/TranscriptionTopicTranscriptionRequestStatus.md index ff956cc84..d176ed010 100644 --- a/build/docs/TranscriptionTopicTranscriptionRequestStatus.md +++ b/build/docs/TranscriptionTopicTranscriptionRequestStatus.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Transcripts.md b/build/docs/Transcripts.md index f96cb7bd3..b3b6f6a84 100644 --- a/build/docs/Transcripts.md +++ b/build/docs/Transcripts.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TransferDestination.md b/build/docs/TransferDestination.md index a458abdba..e5f09349b 100644 --- a/build/docs/TransferDestination.md +++ b/build/docs/TransferDestination.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TransferInitiator.md b/build/docs/TransferInitiator.md index d8cdb0b86..3675606bc 100644 --- a/build/docs/TransferInitiator.md +++ b/build/docs/TransferInitiator.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TransferRequest.md b/build/docs/TransferRequest.md index c6fc5d169..0c5bf3aa1 100644 --- a/build/docs/TransferRequest.md +++ b/build/docs/TransferRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TransferResponse.md b/build/docs/TransferResponse.md index 56890ee53..a9ca64f59 100644 --- a/build/docs/TransferResponse.md +++ b/build/docs/TransferResponse.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TransferResponseModifiedBy.md b/build/docs/TransferResponseModifiedBy.md index 9824d74c1..23b488cc7 100644 --- a/build/docs/TransferResponseModifiedBy.md +++ b/build/docs/TransferResponseModifiedBy.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TransferToAgentRequest.md b/build/docs/TransferToAgentRequest.md index 16779230c..2fc040f4e 100644 --- a/build/docs/TransferToAgentRequest.md +++ b/build/docs/TransferToAgentRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TransferToExternalRequest.md b/build/docs/TransferToExternalRequest.md index 8032f5a5c..891767c1b 100644 --- a/build/docs/TransferToExternalRequest.md +++ b/build/docs/TransferToExternalRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TransferToQueueRequest.md b/build/docs/TransferToQueueRequest.md index cdba1f4dc..85a649ea4 100644 --- a/build/docs/TransferToQueueRequest.md +++ b/build/docs/TransferToQueueRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrendData.md b/build/docs/TrendData.md index 640499243..4b59eeada 100644 --- a/build/docs/TrendData.md +++ b/build/docs/TrendData.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Trigger.md b/build/docs/Trigger.md index 4a36a3005..98f3548b0 100644 --- a/build/docs/Trigger.md +++ b/build/docs/Trigger.md @@ -21,4 +21,4 @@ Defines a process automation trigger. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TriggerEntityListing.md b/build/docs/TriggerEntityListing.md index 1c8c26081..f2494c245 100644 --- a/build/docs/TriggerEntityListing.md +++ b/build/docs/TriggerEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TriggerTarget.md b/build/docs/TriggerTarget.md index 80876cf28..37879f204 100644 --- a/build/docs/TriggerTarget.md +++ b/build/docs/TriggerTarget.md @@ -13,4 +13,4 @@ The target of a trigger invocation -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Trunk.md b/build/docs/Trunk.md index c8214774f..2948e8c96 100644 --- a/build/docs/Trunk.md +++ b/build/docs/Trunk.md @@ -38,4 +38,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkBase.md b/build/docs/TrunkBase.md index cfca3fa22..79512a183 100644 --- a/build/docs/TrunkBase.md +++ b/build/docs/TrunkBase.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkBaseAssignment.md b/build/docs/TrunkBaseAssignment.md index ed986f6f0..a8c8f0dbd 100644 --- a/build/docs/TrunkBaseAssignment.md +++ b/build/docs/TrunkBaseAssignment.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkBaseEntityListing.md b/build/docs/TrunkBaseEntityListing.md index 941b7d66d..f1618c5ae 100644 --- a/build/docs/TrunkBaseEntityListing.md +++ b/build/docs/TrunkBaseEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkConnectedStatus.md b/build/docs/TrunkConnectedStatus.md index 288e91307..84783e859 100644 --- a/build/docs/TrunkConnectedStatus.md +++ b/build/docs/TrunkConnectedStatus.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkEntityListing.md b/build/docs/TrunkEntityListing.md index a30bdfee4..13fd0b021 100644 --- a/build/docs/TrunkEntityListing.md +++ b/build/docs/TrunkEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkErrorInfo.md b/build/docs/TrunkErrorInfo.md index 3a0bf4017..0f616d2b7 100644 --- a/build/docs/TrunkErrorInfo.md +++ b/build/docs/TrunkErrorInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkErrorInfoDetails.md b/build/docs/TrunkErrorInfoDetails.md index f49b62f47..d24c7c053 100644 --- a/build/docs/TrunkErrorInfoDetails.md +++ b/build/docs/TrunkErrorInfoDetails.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkInstanceTopicTrunk.md b/build/docs/TrunkInstanceTopicTrunk.md index c82ece39f..fa856cfa6 100644 --- a/build/docs/TrunkInstanceTopicTrunk.md +++ b/build/docs/TrunkInstanceTopicTrunk.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkInstanceTopicTrunkConnectedStatus.md b/build/docs/TrunkInstanceTopicTrunkConnectedStatus.md index 881d6cb7f..0e48d23e0 100644 --- a/build/docs/TrunkInstanceTopicTrunkConnectedStatus.md +++ b/build/docs/TrunkInstanceTopicTrunkConnectedStatus.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkInstanceTopicTrunkErrorInfo.md b/build/docs/TrunkInstanceTopicTrunkErrorInfo.md index 5c43fe5a5..0e6dd9542 100644 --- a/build/docs/TrunkInstanceTopicTrunkErrorInfo.md +++ b/build/docs/TrunkInstanceTopicTrunkErrorInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkInstanceTopicTrunkErrorInfoDetails.md b/build/docs/TrunkInstanceTopicTrunkErrorInfoDetails.md index cf53b0113..21f3601d5 100644 --- a/build/docs/TrunkInstanceTopicTrunkErrorInfoDetails.md +++ b/build/docs/TrunkInstanceTopicTrunkErrorInfoDetails.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkInstanceTopicTrunkMetricsNetworkTypeIp.md b/build/docs/TrunkInstanceTopicTrunkMetricsNetworkTypeIp.md index 150a9df4b..87253eb54 100644 --- a/build/docs/TrunkInstanceTopicTrunkMetricsNetworkTypeIp.md +++ b/build/docs/TrunkInstanceTopicTrunkMetricsNetworkTypeIp.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkInstanceTopicTrunkMetricsOptions.md b/build/docs/TrunkInstanceTopicTrunkMetricsOptions.md index 4f0f149e4..3278bfb8e 100644 --- a/build/docs/TrunkInstanceTopicTrunkMetricsOptions.md +++ b/build/docs/TrunkInstanceTopicTrunkMetricsOptions.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkInstanceTopicTrunkMetricsRegisters.md b/build/docs/TrunkInstanceTopicTrunkMetricsRegisters.md index 67cbfa234..e78dcf07f 100644 --- a/build/docs/TrunkInstanceTopicTrunkMetricsRegisters.md +++ b/build/docs/TrunkInstanceTopicTrunkMetricsRegisters.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetabaseEntityListing.md b/build/docs/TrunkMetabaseEntityListing.md index 4c326ca33..6efd30b56 100644 --- a/build/docs/TrunkMetabaseEntityListing.md +++ b/build/docs/TrunkMetabaseEntityListing.md @@ -11,13 +11,13 @@ | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | | **totalNumberOfEntities** | **Int64** | The total organization-wide number of entities. | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetrics.md b/build/docs/TrunkMetrics.md index 9691b4645..528930dfe 100644 --- a/build/docs/TrunkMetrics.md +++ b/build/docs/TrunkMetrics.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsCalls.md b/build/docs/TrunkMetricsCalls.md index 4f5c3119d..438015966 100644 --- a/build/docs/TrunkMetricsCalls.md +++ b/build/docs/TrunkMetricsCalls.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsNetworkTypeIp.md b/build/docs/TrunkMetricsNetworkTypeIp.md index 663f98c1f..f6cbf7b4b 100644 --- a/build/docs/TrunkMetricsNetworkTypeIp.md +++ b/build/docs/TrunkMetricsNetworkTypeIp.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsOptions.md b/build/docs/TrunkMetricsOptions.md index ae3c246a5..d0419cd51 100644 --- a/build/docs/TrunkMetricsOptions.md +++ b/build/docs/TrunkMetricsOptions.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsQoS.md b/build/docs/TrunkMetricsQoS.md index 2d5310120..de0ae7f29 100644 --- a/build/docs/TrunkMetricsQoS.md +++ b/build/docs/TrunkMetricsQoS.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsRegisters.md b/build/docs/TrunkMetricsRegisters.md index 5b820d506..01e78c295 100644 --- a/build/docs/TrunkMetricsRegisters.md +++ b/build/docs/TrunkMetricsRegisters.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsTopicTrunkMetrics.md b/build/docs/TrunkMetricsTopicTrunkMetrics.md index df01dd2dc..cb931699a 100644 --- a/build/docs/TrunkMetricsTopicTrunkMetrics.md +++ b/build/docs/TrunkMetricsTopicTrunkMetrics.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsTopicTrunkMetricsCalls.md b/build/docs/TrunkMetricsTopicTrunkMetricsCalls.md index 95e0960ce..44f260934 100644 --- a/build/docs/TrunkMetricsTopicTrunkMetricsCalls.md +++ b/build/docs/TrunkMetricsTopicTrunkMetricsCalls.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsTopicTrunkMetricsQoS.md b/build/docs/TrunkMetricsTopicTrunkMetricsQoS.md index efa0dc888..6f3351bc5 100644 --- a/build/docs/TrunkMetricsTopicTrunkMetricsQoS.md +++ b/build/docs/TrunkMetricsTopicTrunkMetricsQoS.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkMetricsTopicUriReference.md b/build/docs/TrunkMetricsTopicUriReference.md index 7b12c9397..bd0b97b50 100644 --- a/build/docs/TrunkMetricsTopicUriReference.md +++ b/build/docs/TrunkMetricsTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrunkRecordingEnabledCount.md b/build/docs/TrunkRecordingEnabledCount.md index 595db335a..2eec58fcb 100644 --- a/build/docs/TrunkRecordingEnabledCount.md +++ b/build/docs/TrunkRecordingEnabledCount.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustCreate.md b/build/docs/TrustCreate.md index a34e64500..b6e1c7b6b 100644 --- a/build/docs/TrustCreate.md +++ b/build/docs/TrustCreate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustEntityListing.md b/build/docs/TrustEntityListing.md index 6108e5a6b..05aa32a85 100644 --- a/build/docs/TrustEntityListing.md +++ b/build/docs/TrustEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustGroup.md b/build/docs/TrustGroup.md index 7754691cd..59b58e4c2 100644 --- a/build/docs/TrustGroup.md +++ b/build/docs/TrustGroup.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustGroupEntityListing.md b/build/docs/TrustGroupEntityListing.md index 9c1eabfac..d88d0aa0d 100644 --- a/build/docs/TrustGroupEntityListing.md +++ b/build/docs/TrustGroupEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustMemberCreate.md b/build/docs/TrustMemberCreate.md index dc9076c2e..7104a03e6 100644 --- a/build/docs/TrustMemberCreate.md +++ b/build/docs/TrustMemberCreate.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustRequest.md b/build/docs/TrustRequest.md index d8df0b43c..54a664fe1 100644 --- a/build/docs/TrustRequest.md +++ b/build/docs/TrustRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustRequestCreate.md b/build/docs/TrustRequestCreate.md index 08ca501dd..3d6d1c2f7 100644 --- a/build/docs/TrustRequestCreate.md +++ b/build/docs/TrustRequestCreate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustUpdate.md b/build/docs/TrustUpdate.md index a203d9074..a7ab1d8a5 100644 --- a/build/docs/TrustUpdate.md +++ b/build/docs/TrustUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustUser.md b/build/docs/TrustUser.md index cc74f1d9d..4f87525b1 100644 --- a/build/docs/TrustUser.md +++ b/build/docs/TrustUser.md @@ -47,4 +47,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustUserDetails.md b/build/docs/TrustUserDetails.md index 5135ffb84..b04cb77c2 100644 --- a/build/docs/TrustUserDetails.md +++ b/build/docs/TrustUserDetails.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustUserEntityListing.md b/build/docs/TrustUserEntityListing.md index 5942c3e82..fb7c88404 100644 --- a/build/docs/TrustUserEntityListing.md +++ b/build/docs/TrustUserEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustedCertificateInfo.md b/build/docs/TrustedCertificateInfo.md index bf3f947a5..00f25dd54 100644 --- a/build/docs/TrustedCertificateInfo.md +++ b/build/docs/TrustedCertificateInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustedCertificates.md b/build/docs/TrustedCertificates.md index f4102cfb7..3a804337f 100644 --- a/build/docs/TrustedCertificates.md +++ b/build/docs/TrustedCertificates.md @@ -12,4 +12,4 @@ Information about trusted certificates -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Trustee.md b/build/docs/Trustee.md index 2b11a92d1..66d7ba3bb 100644 --- a/build/docs/Trustee.md +++ b/build/docs/Trustee.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrusteeAuditQueryRequest.md b/build/docs/TrusteeAuditQueryRequest.md index 14a740071..a2cd7b709 100644 --- a/build/docs/TrusteeAuditQueryRequest.md +++ b/build/docs/TrusteeAuditQueryRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrusteeAuthorization.md b/build/docs/TrusteeAuthorization.md index a7bd51cc1..8c3662ddf 100644 --- a/build/docs/TrusteeAuthorization.md +++ b/build/docs/TrusteeAuthorization.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrusteeBillingOverview.md b/build/docs/TrusteeBillingOverview.md index 0ada6101f..975a2cf59 100644 --- a/build/docs/TrusteeBillingOverview.md +++ b/build/docs/TrusteeBillingOverview.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrusteeReferenceList.md b/build/docs/TrusteeReferenceList.md index 3b9a4837c..68d369ddb 100644 --- a/build/docs/TrusteeReferenceList.md +++ b/build/docs/TrusteeReferenceList.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Trustor.md b/build/docs/Trustor.md index 80aefc2ac..2dbd362f5 100644 --- a/build/docs/Trustor.md +++ b/build/docs/Trustor.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustorAuditQueryRequest.md b/build/docs/TrustorAuditQueryRequest.md index 8d55e9016..fd9d6726d 100644 --- a/build/docs/TrustorAuditQueryRequest.md +++ b/build/docs/TrustorAuditQueryRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TrustorEntityListing.md b/build/docs/TrustorEntityListing.md index ade03a3a2..2ccf7871b 100644 --- a/build/docs/TrustorEntityListing.md +++ b/build/docs/TrustorEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TtsEngineEntity.md b/build/docs/TtsEngineEntity.md index 39b995023..7c3cdac5f 100644 --- a/build/docs/TtsEngineEntity.md +++ b/build/docs/TtsEngineEntity.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TtsEngineEntityListing.md b/build/docs/TtsEngineEntityListing.md index 2d87edcc9..5cf29c3aa 100644 --- a/build/docs/TtsEngineEntityListing.md +++ b/build/docs/TtsEngineEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TtsSettings.md b/build/docs/TtsSettings.md index cf49c8939..ffc7439ef 100644 --- a/build/docs/TtsSettings.md +++ b/build/docs/TtsSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TtsVoiceEntity.md b/build/docs/TtsVoiceEntity.md index 080230c81..cdbed974b 100644 --- a/build/docs/TtsVoiceEntity.md +++ b/build/docs/TtsVoiceEntity.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TtsVoiceEntityListing.md b/build/docs/TtsVoiceEntityListing.md index 0e4f55f6d..e3c0b4e00 100644 --- a/build/docs/TtsVoiceEntityListing.md +++ b/build/docs/TtsVoiceEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TwitterId.md b/build/docs/TwitterId.md index fd009b09c..baf08f16f 100644 --- a/build/docs/TwitterId.md +++ b/build/docs/TwitterId.md @@ -15,4 +15,4 @@ User information for a twitter account -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/TypingSetting.md b/build/docs/TypingSetting.md index 33ba3aa5b..5453618c7 100644 --- a/build/docs/TypingSetting.md +++ b/build/docs/TypingSetting.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UCI10n.md b/build/docs/UCI10n.md index 03ae5e0a2..5e8ca3dff 100644 --- a/build/docs/UCI10n.md +++ b/build/docs/UCI10n.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UCIcon.md b/build/docs/UCIcon.md index c0064db2a..6585d586b 100644 --- a/build/docs/UCIcon.md +++ b/build/docs/UCIcon.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UCIntegration.md b/build/docs/UCIntegration.md index e18e7cddf..7f09bcd18 100644 --- a/build/docs/UCIntegration.md +++ b/build/docs/UCIntegration.md @@ -21,4 +21,4 @@ UC Integration UI configuration data -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UCIntegrationListing.md b/build/docs/UCIntegrationListing.md index 582c14d8a..694c430df 100644 --- a/build/docs/UCIntegrationListing.md +++ b/build/docs/UCIntegrationListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UCThirdPartyPresence.md b/build/docs/UCThirdPartyPresence.md index 295122003..ef7017abb 100644 --- a/build/docs/UCThirdPartyPresence.md +++ b/build/docs/UCThirdPartyPresence.md @@ -14,4 +14,4 @@ Update a Genesys Cloud user's presence from a given 3rd-party integration -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UcUserPresence.md b/build/docs/UcUserPresence.md index 703d73418..2c396889f 100644 --- a/build/docs/UcUserPresence.md +++ b/build/docs/UcUserPresence.md @@ -19,4 +19,4 @@ Presence from a given source for a user -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnansweredGroup.md b/build/docs/UnansweredGroup.md index 4b0a19ea3..3549c0365 100644 --- a/build/docs/UnansweredGroup.md +++ b/build/docs/UnansweredGroup.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnansweredGroupSuggestedDocument.md b/build/docs/UnansweredGroupSuggestedDocument.md index 2b984780d..57e7d76ad 100644 --- a/build/docs/UnansweredGroupSuggestedDocument.md +++ b/build/docs/UnansweredGroupSuggestedDocument.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnansweredGroups.md b/build/docs/UnansweredGroups.md index 5bf78d293..9d54a176f 100644 --- a/build/docs/UnansweredGroups.md +++ b/build/docs/UnansweredGroups.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnansweredPhrase.md b/build/docs/UnansweredPhrase.md index b61046497..f62e4d658 100644 --- a/build/docs/UnansweredPhrase.md +++ b/build/docs/UnansweredPhrase.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnansweredPhraseGroup.md b/build/docs/UnansweredPhraseGroup.md index 42a5d6a34..c39f8b067 100644 --- a/build/docs/UnansweredPhraseGroup.md +++ b/build/docs/UnansweredPhraseGroup.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnansweredPhraseGroupPatchRequestBody.md b/build/docs/UnansweredPhraseGroupPatchRequestBody.md index 5dffeb6ce..cee90e818 100644 --- a/build/docs/UnansweredPhraseGroupPatchRequestBody.md +++ b/build/docs/UnansweredPhraseGroupPatchRequestBody.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnansweredPhraseGroupUpdateResponse.md b/build/docs/UnansweredPhraseGroupUpdateResponse.md index aaac47f90..e9baa722c 100644 --- a/build/docs/UnansweredPhraseGroupUpdateResponse.md +++ b/build/docs/UnansweredPhraseGroupUpdateResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnifiedCommunicationsIntegration.md b/build/docs/UnifiedCommunicationsIntegration.md index 669eade88..9130779f2 100644 --- a/build/docs/UnifiedCommunicationsIntegration.md +++ b/build/docs/UnifiedCommunicationsIntegration.md @@ -24,4 +24,4 @@ UC Integration UI configuration data -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnifiedCommunicationsIntegrationListing.md b/build/docs/UnifiedCommunicationsIntegrationListing.md index 1b5eda2fe..9881a1dbc 100644 --- a/build/docs/UnifiedCommunicationsIntegrationListing.md +++ b/build/docs/UnifiedCommunicationsIntegrationListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnifiedGeneralTopic.md b/build/docs/UnifiedGeneralTopic.md index 3996e7152..12c9bf792 100644 --- a/build/docs/UnifiedGeneralTopic.md +++ b/build/docs/UnifiedGeneralTopic.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnifiedGeneralTopicEntityListing.md b/build/docs/UnifiedGeneralTopicEntityListing.md index 331e3bb58..9ff0c1ff9 100644 --- a/build/docs/UnifiedGeneralTopicEntityListing.md +++ b/build/docs/UnifiedGeneralTopicEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnpublishedProgramsEntityListing.md b/build/docs/UnpublishedProgramsEntityListing.md index 91e5102f5..fddfd3309 100644 --- a/build/docs/UnpublishedProgramsEntityListing.md +++ b/build/docs/UnpublishedProgramsEntityListing.md @@ -8,10 +8,10 @@ |------------ | ------------- | ------------- | -------------| | **entities** | [**[Program]**](Program) | | [optional] | | **pageSize** | **Int** | | [optional] | -| **nextUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | +| **nextUri** | **String** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnreadFields.md b/build/docs/UnreadFields.md index 0d7b7d003..dba6884fe 100644 --- a/build/docs/UnreadFields.md +++ b/build/docs/UnreadFields.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnreadMetric.md b/build/docs/UnreadMetric.md index 695301fdd..a005d53ba 100644 --- a/build/docs/UnreadMetric.md +++ b/build/docs/UnreadMetric.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UnreadStatus.md b/build/docs/UnreadStatus.md index abf883cd0..f2a02ad93 100644 --- a/build/docs/UnreadStatus.md +++ b/build/docs/UnreadStatus.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateActionInput.md b/build/docs/UpdateActionInput.md index 1206b56a1..50cf78050 100644 --- a/build/docs/UpdateActionInput.md +++ b/build/docs/UpdateActionInput.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateActivityCodeRequest.md b/build/docs/UpdateActivityCodeRequest.md index 30bcd6f2e..54fd880e0 100644 --- a/build/docs/UpdateActivityCodeRequest.md +++ b/build/docs/UpdateActivityCodeRequest.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateActivityPlanRequest.md b/build/docs/UpdateActivityPlanRequest.md index 19a3c42c6..e4d731e1d 100644 --- a/build/docs/UpdateActivityPlanRequest.md +++ b/build/docs/UpdateActivityPlanRequest.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateAdherenceExplanationStatusRequest.md b/build/docs/UpdateAdherenceExplanationStatusRequest.md index bb799aaca..23513aeb9 100644 --- a/build/docs/UpdateAdherenceExplanationStatusRequest.md +++ b/build/docs/UpdateAdherenceExplanationStatusRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateAgentWorkPlanBiddingPreference.md b/build/docs/UpdateAgentWorkPlanBiddingPreference.md index 30516037a..f3cacbdb7 100644 --- a/build/docs/UpdateAgentWorkPlanBiddingPreference.md +++ b/build/docs/UpdateAgentWorkPlanBiddingPreference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateAlternativeShiftBuSettingsRequest.md b/build/docs/UpdateAlternativeShiftBuSettingsRequest.md index 1483bcf82..b446d98d2 100644 --- a/build/docs/UpdateAlternativeShiftBuSettingsRequest.md +++ b/build/docs/UpdateAlternativeShiftBuSettingsRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateAnalyticsDataRetentionRequest.md b/build/docs/UpdateAnalyticsDataRetentionRequest.md index cb531d202..60adb7cac 100644 --- a/build/docs/UpdateAnalyticsDataRetentionRequest.md +++ b/build/docs/UpdateAnalyticsDataRetentionRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateBusinessUnitRequest.md b/build/docs/UpdateBusinessUnitRequest.md index d07059453..4c4c2db16 100644 --- a/build/docs/UpdateBusinessUnitRequest.md +++ b/build/docs/UpdateBusinessUnitRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateBusinessUnitSettingsRequest.md b/build/docs/UpdateBusinessUnitSettingsRequest.md index 1e2180d2d..05478c2c9 100644 --- a/build/docs/UpdateBusinessUnitSettingsRequest.md +++ b/build/docs/UpdateBusinessUnitSettingsRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateCoachingAppointmentRequest.md b/build/docs/UpdateCoachingAppointmentRequest.md index 0a4713d1e..a1a45a360 100644 --- a/build/docs/UpdateCoachingAppointmentRequest.md +++ b/build/docs/UpdateCoachingAppointmentRequest.md @@ -19,4 +19,4 @@ Update coaching appointment request -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateContactColumnActionSettings.md b/build/docs/UpdateContactColumnActionSettings.md index fa74822bf..4d30b39fa 100644 --- a/build/docs/UpdateContactColumnActionSettings.md +++ b/build/docs/UpdateContactColumnActionSettings.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateDraftInput.md b/build/docs/UpdateDraftInput.md index 206ee001a..a897b23db 100644 --- a/build/docs/UpdateDraftInput.md +++ b/build/docs/UpdateDraftInput.md @@ -16,4 +16,4 @@ Definition of an Action Draft to be created or updated. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateManagementUnitRequest.md b/build/docs/UpdateManagementUnitRequest.md index 56dfe5f53..68b075233 100644 --- a/build/docs/UpdateManagementUnitRequest.md +++ b/build/docs/UpdateManagementUnitRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateMuAgentRequest.md b/build/docs/UpdateMuAgentRequest.md index 8f31672c4..be03240fa 100644 --- a/build/docs/UpdateMuAgentRequest.md +++ b/build/docs/UpdateMuAgentRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateMuAgentWorkPlanFailureResponse.md b/build/docs/UpdateMuAgentWorkPlanFailureResponse.md index 8df2a2e5f..48d894a69 100644 --- a/build/docs/UpdateMuAgentWorkPlanFailureResponse.md +++ b/build/docs/UpdateMuAgentWorkPlanFailureResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateMuAgentWorkPlanRequest.md b/build/docs/UpdateMuAgentWorkPlanRequest.md index ebed1ac34..d6e7b5409 100644 --- a/build/docs/UpdateMuAgentWorkPlanRequest.md +++ b/build/docs/UpdateMuAgentWorkPlanRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateMuAgentWorkPlansBatchRequest.md b/build/docs/UpdateMuAgentWorkPlansBatchRequest.md index d767f714d..c6aa72ce8 100644 --- a/build/docs/UpdateMuAgentWorkPlansBatchRequest.md +++ b/build/docs/UpdateMuAgentWorkPlansBatchRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateMuAgentWorkPlansBatchResponse.md b/build/docs/UpdateMuAgentWorkPlansBatchResponse.md index e55bc52c9..1edb74cd1 100644 --- a/build/docs/UpdateMuAgentWorkPlansBatchResponse.md +++ b/build/docs/UpdateMuAgentWorkPlansBatchResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateMuAgentsRequest.md b/build/docs/UpdateMuAgentsRequest.md index eedff498c..033ba6aa4 100644 --- a/build/docs/UpdateMuAgentsRequest.md +++ b/build/docs/UpdateMuAgentsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateNotificationResponse.md b/build/docs/UpdateNotificationResponse.md index a8f9c4ec9..c880d2971 100644 --- a/build/docs/UpdateNotificationResponse.md +++ b/build/docs/UpdateNotificationResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateNotificationsRequest.md b/build/docs/UpdateNotificationsRequest.md index 1ace0cf43..72612be32 100644 --- a/build/docs/UpdateNotificationsRequest.md +++ b/build/docs/UpdateNotificationsRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateNotificationsResponse.md b/build/docs/UpdateNotificationsResponse.md index b8d734449..9ff015ccf 100644 --- a/build/docs/UpdateNotificationsResponse.md +++ b/build/docs/UpdateNotificationsResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdatePlanningGroupRequest.md b/build/docs/UpdatePlanningGroupRequest.md index 181e1c796..9d298b62c 100644 --- a/build/docs/UpdatePlanningGroupRequest.md +++ b/build/docs/UpdatePlanningGroupRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateScheduleUploadResponse.md b/build/docs/UpdateScheduleUploadResponse.md index 6d8377fc6..8eeadd873 100644 --- a/build/docs/UpdateScheduleUploadResponse.md +++ b/build/docs/UpdateScheduleUploadResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateScheduleUploadSchema.md b/build/docs/UpdateScheduleUploadSchema.md index 721f3ea9c..6bb544960 100644 --- a/build/docs/UpdateScheduleUploadSchema.md +++ b/build/docs/UpdateScheduleUploadSchema.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateServiceGoalTemplate.md b/build/docs/UpdateServiceGoalTemplate.md index 62eae5636..43530bcbf 100644 --- a/build/docs/UpdateServiceGoalTemplate.md +++ b/build/docs/UpdateServiceGoalTemplate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateStaffingGroupRequest.md b/build/docs/UpdateStaffingGroupRequest.md index d81b927d3..632cd6529 100644 --- a/build/docs/UpdateStaffingGroupRequest.md +++ b/build/docs/UpdateStaffingGroupRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateTimeOffLimitRequest.md b/build/docs/UpdateTimeOffLimitRequest.md index 355c2eddf..566e2396c 100644 --- a/build/docs/UpdateTimeOffLimitRequest.md +++ b/build/docs/UpdateTimeOffLimitRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateTimeOffPlanBusinessUnitAssociation.md b/build/docs/UpdateTimeOffPlanBusinessUnitAssociation.md index 33e266b38..8a75a3802 100644 --- a/build/docs/UpdateTimeOffPlanBusinessUnitAssociation.md +++ b/build/docs/UpdateTimeOffPlanBusinessUnitAssociation.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateTimeOffPlanManagementUnitAssociation.md b/build/docs/UpdateTimeOffPlanManagementUnitAssociation.md index f35829bd8..ee849cf79 100644 --- a/build/docs/UpdateTimeOffPlanManagementUnitAssociation.md +++ b/build/docs/UpdateTimeOffPlanManagementUnitAssociation.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateTimeOffPlanRequest.md b/build/docs/UpdateTimeOffPlanRequest.md index 105df1f29..98ef3216d 100644 --- a/build/docs/UpdateTimeOffPlanRequest.md +++ b/build/docs/UpdateTimeOffPlanRequest.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateTriggerRequest.md b/build/docs/UpdateTriggerRequest.md index 0481b83c6..0444afeef 100644 --- a/build/docs/UpdateTriggerRequest.md +++ b/build/docs/UpdateTriggerRequest.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateUser.md b/build/docs/UpdateUser.md index f9cfd1c2d..9510c629e 100644 --- a/build/docs/UpdateUser.md +++ b/build/docs/UpdateUser.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateUtilizationLabelRequest.md b/build/docs/UpdateUtilizationLabelRequest.md index aa55543df..2643b60c3 100644 --- a/build/docs/UpdateUtilizationLabelRequest.md +++ b/build/docs/UpdateUtilizationLabelRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateVerifierRequest.md b/build/docs/UpdateVerifierRequest.md index 902531fbd..49becb348 100644 --- a/build/docs/UpdateVerifierRequest.md +++ b/build/docs/UpdateVerifierRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateWorkPlanBid.md b/build/docs/UpdateWorkPlanBid.md index 45b1acf27..a4c9dd063 100644 --- a/build/docs/UpdateWorkPlanBid.md +++ b/build/docs/UpdateWorkPlanBid.md @@ -19,4 +19,4 @@ Update work plan bid model -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateWorkPlanRotationAgentRequest.md b/build/docs/UpdateWorkPlanRotationAgentRequest.md index 7eb356516..778d0766f 100644 --- a/build/docs/UpdateWorkPlanRotationAgentRequest.md +++ b/build/docs/UpdateWorkPlanRotationAgentRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UpdateWorkPlanRotationRequest.md b/build/docs/UpdateWorkPlanRotationRequest.md index 9208a3383..01a8defee 100644 --- a/build/docs/UpdateWorkPlanRotationRequest.md +++ b/build/docs/UpdateWorkPlanRotationRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UploadUrlRequest.md b/build/docs/UploadUrlRequest.md index cde71ea18..78219f77f 100644 --- a/build/docs/UploadUrlRequest.md +++ b/build/docs/UploadUrlRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UploadUrlRequestBody.md b/build/docs/UploadUrlRequestBody.md index f9c8aa9fe..61daabc06 100644 --- a/build/docs/UploadUrlRequestBody.md +++ b/build/docs/UploadUrlRequestBody.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UploadUrlResponse.md b/build/docs/UploadUrlResponse.md index b3c594173..271dc39c9 100644 --- a/build/docs/UploadUrlResponse.md +++ b/build/docs/UploadUrlResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UploadsAPI.md b/build/docs/UploadsAPI.md index 841554c88..72fe5f241 100644 --- a/build/docs/UploadsAPI.md +++ b/build/docs/UploadsAPI.md @@ -315,4 +315,4 @@ UploadsAPI.postUploadsWorkforcemanagementHistoricaldataCsv(body: body) { (respon [**UploadUrlResponse**](UploadUrlResponse) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UrlCondition.md b/build/docs/UrlCondition.md index f5e4d8d82..759ed36d1 100644 --- a/build/docs/UrlCondition.md +++ b/build/docs/UrlCondition.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UrlResponse.md b/build/docs/UrlResponse.md index 9e8eec274..5a5235e6a 100644 --- a/build/docs/UrlResponse.md +++ b/build/docs/UrlResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Usage.md b/build/docs/Usage.md index 12c4bb06a..2823aee17 100644 --- a/build/docs/Usage.md +++ b/build/docs/Usage.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UsageAPI.md b/build/docs/UsageAPI.md index 20197db65..592fc6154 100644 --- a/build/docs/UsageAPI.md +++ b/build/docs/UsageAPI.md @@ -389,4 +389,4 @@ UsageAPI.postUsageSimplesearch(body: body) { (response, error) in [**UsageExecutionResult**](UsageExecutionResult) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UsageExecutionResult.md b/build/docs/UsageExecutionResult.md index 588832309..db9df1eb0 100644 --- a/build/docs/UsageExecutionResult.md +++ b/build/docs/UsageExecutionResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UsageItem.md b/build/docs/UsageItem.md index 59b93bd1b..1836f2442 100644 --- a/build/docs/UsageItem.md +++ b/build/docs/UsageItem.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/User.md b/build/docs/User.md index ed4b2b801..e89032f88 100644 --- a/build/docs/User.md +++ b/build/docs/User.md @@ -47,4 +47,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityData.md b/build/docs/UserActivityData.md index ab8127513..58503e900 100644 --- a/build/docs/UserActivityData.md +++ b/build/docs/UserActivityData.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityEntityData.md b/build/docs/UserActivityEntityData.md index 37bde1adb..26b4aa5c6 100644 --- a/build/docs/UserActivityEntityData.md +++ b/build/docs/UserActivityEntityData.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityMetricValue.md b/build/docs/UserActivityMetricValue.md index 805536c93..a94ba293c 100644 --- a/build/docs/UserActivityMetricValue.md +++ b/build/docs/UserActivityMetricValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityQuery.md b/build/docs/UserActivityQuery.md index 787bd83a7..01dba70bf 100644 --- a/build/docs/UserActivityQuery.md +++ b/build/docs/UserActivityQuery.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityQueryClause.md b/build/docs/UserActivityQueryClause.md index 8649a6599..7187afc62 100644 --- a/build/docs/UserActivityQueryClause.md +++ b/build/docs/UserActivityQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityQueryFilter.md b/build/docs/UserActivityQueryFilter.md index 6e82a8854..1d47c21a0 100644 --- a/build/docs/UserActivityQueryFilter.md +++ b/build/docs/UserActivityQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityQueryMetric.md b/build/docs/UserActivityQueryMetric.md index 12482e93b..39e586f16 100644 --- a/build/docs/UserActivityQueryMetric.md +++ b/build/docs/UserActivityQueryMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityQueryPredicate.md b/build/docs/UserActivityQueryPredicate.md index 7b89c7343..3b5f612c0 100644 --- a/build/docs/UserActivityQueryPredicate.md +++ b/build/docs/UserActivityQueryPredicate.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserActivityResponse.md b/build/docs/UserActivityResponse.md index d7f3a99bb..0ad06639c 100644 --- a/build/docs/UserActivityResponse.md +++ b/build/docs/UserActivityResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAgentInfo.md b/build/docs/UserAgentInfo.md index c0c9ca489..19e07afb3 100644 --- a/build/docs/UserAgentInfo.md +++ b/build/docs/UserAgentInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAggregateDataContainer.md b/build/docs/UserAggregateDataContainer.md index d701a8779..bdda7e8fd 100644 --- a/build/docs/UserAggregateDataContainer.md +++ b/build/docs/UserAggregateDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAggregateQueryClause.md b/build/docs/UserAggregateQueryClause.md index 32b45b365..d27c1e7a6 100644 --- a/build/docs/UserAggregateQueryClause.md +++ b/build/docs/UserAggregateQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAggregateQueryFilter.md b/build/docs/UserAggregateQueryFilter.md index aaeb2d4a2..38cd9d1de 100644 --- a/build/docs/UserAggregateQueryFilter.md +++ b/build/docs/UserAggregateQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAggregateQueryPredicate.md b/build/docs/UserAggregateQueryPredicate.md index 6efa4809c..17d9cfa56 100644 --- a/build/docs/UserAggregateQueryPredicate.md +++ b/build/docs/UserAggregateQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAggregateQueryResponse.md b/build/docs/UserAggregateQueryResponse.md index 46fe7622b..12c82c3e8 100644 --- a/build/docs/UserAggregateQueryResponse.md +++ b/build/docs/UserAggregateQueryResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAggregationQuery.md b/build/docs/UserAggregationQuery.md index fb6b3e5bb..f0caf356c 100644 --- a/build/docs/UserAggregationQuery.md +++ b/build/docs/UserAggregationQuery.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAggregationView.md b/build/docs/UserAggregationView.md index f42602a65..619423b86 100644 --- a/build/docs/UserAggregationView.md +++ b/build/docs/UserAggregationView.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserApp.md b/build/docs/UserApp.md index 8f17638ff..87e3f2ce7 100644 --- a/build/docs/UserApp.md +++ b/build/docs/UserApp.md @@ -15,4 +15,4 @@ Details for a UserApp -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAppConfigurationInfo.md b/build/docs/UserAppConfigurationInfo.md index a71f42422..34c28c6e7 100644 --- a/build/docs/UserAppConfigurationInfo.md +++ b/build/docs/UserAppConfigurationInfo.md @@ -12,4 +12,4 @@ Configuration information for the integration -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAppEntityListing.md b/build/docs/UserAppEntityListing.md index 0af6535c7..81f295de2 100644 --- a/build/docs/UserAppEntityListing.md +++ b/build/docs/UserAppEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAuthorization.md b/build/docs/UserAuthorization.md index 40de8f691..69bdb76db 100644 --- a/build/docs/UserAuthorization.md +++ b/build/docs/UserAuthorization.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserAvailableTimes.md b/build/docs/UserAvailableTimes.md index 08f5ac193..51fc9072b 100644 --- a/build/docs/UserAvailableTimes.md +++ b/build/docs/UserAvailableTimes.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserBestPoints.md b/build/docs/UserBestPoints.md index 99533a7a3..e2dcbac5c 100644 --- a/build/docs/UserBestPoints.md +++ b/build/docs/UserBestPoints.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserBestPointsItem.md b/build/docs/UserBestPointsItem.md index 9f46fac5e..b73b83265 100644 --- a/build/docs/UserBestPointsItem.md +++ b/build/docs/UserBestPointsItem.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserConversationSummary.md b/build/docs/UserConversationSummary.md index a67fd5bef..845a09cb4 100644 --- a/build/docs/UserConversationSummary.md +++ b/build/docs/UserConversationSummary.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserConversationsEventMediaSummary.md b/build/docs/UserConversationsEventMediaSummary.md index 62187ee1e..42df5df3d 100644 --- a/build/docs/UserConversationsEventMediaSummary.md +++ b/build/docs/UserConversationsEventMediaSummary.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserConversationsEventMediaSummaryDetail.md b/build/docs/UserConversationsEventMediaSummaryDetail.md index 6016108ba..25eb1bd27 100644 --- a/build/docs/UserConversationsEventMediaSummaryDetail.md +++ b/build/docs/UserConversationsEventMediaSummaryDetail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserConversationsEventUserConversationSummary.md b/build/docs/UserConversationsEventUserConversationSummary.md index 8d107200c..0ebfbeefd 100644 --- a/build/docs/UserConversationsEventUserConversationSummary.md +++ b/build/docs/UserConversationsEventUserConversationSummary.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserDetailQueryClause.md b/build/docs/UserDetailQueryClause.md index 9b262f9dc..28f287e10 100644 --- a/build/docs/UserDetailQueryClause.md +++ b/build/docs/UserDetailQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserDetailQueryFilter.md b/build/docs/UserDetailQueryFilter.md index e1cb35c27..3b99c0afc 100644 --- a/build/docs/UserDetailQueryFilter.md +++ b/build/docs/UserDetailQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserDetailQueryPredicate.md b/build/docs/UserDetailQueryPredicate.md index c22ed9980..3459344c4 100644 --- a/build/docs/UserDetailQueryPredicate.md +++ b/build/docs/UserDetailQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification.md b/build/docs/UserDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification.md index 788493d35..668cbbba6 100644 --- a/build/docs/UserDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification.md +++ b/build/docs/UserDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserDetailsQuery.md b/build/docs/UserDetailsQuery.md index 73faac835..6cd846fd1 100644 --- a/build/docs/UserDetailsQuery.md +++ b/build/docs/UserDetailsQuery.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserDevice.md b/build/docs/UserDevice.md index 753cfb353..66264a913 100644 --- a/build/docs/UserDevice.md +++ b/build/docs/UserDevice.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserEndDetailEventTopicUserEndEvent.md b/build/docs/UserEndDetailEventTopicUserEndEvent.md index dd311f739..a3ff9063b 100644 --- a/build/docs/UserEndDetailEventTopicUserEndEvent.md +++ b/build/docs/UserEndDetailEventTopicUserEndEvent.md @@ -37,4 +37,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserEntityListing.md b/build/docs/UserEntityListing.md index 3bf042d17..00dee0326 100644 --- a/build/docs/UserEntityListing.md +++ b/build/docs/UserEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserEstablishedEvent.md b/build/docs/UserEstablishedEvent.md index d7ef232d7..40f1d2fef 100644 --- a/build/docs/UserEstablishedEvent.md +++ b/build/docs/UserEstablishedEvent.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserExpands.md b/build/docs/UserExpands.md index 1abd04b36..886ec808c 100644 --- a/build/docs/UserExpands.md +++ b/build/docs/UserExpands.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserExternalIdentifier.md b/build/docs/UserExternalIdentifier.md index 5a21f4af0..765babc3e 100644 --- a/build/docs/UserExternalIdentifier.md +++ b/build/docs/UserExternalIdentifier.md @@ -13,4 +13,4 @@ Defines a link between an External Identifier and Authority pair to a Entity Typ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserGreetingEventGreeting.md b/build/docs/UserGreetingEventGreeting.md index d13c11ee4..aa651c61a 100644 --- a/build/docs/UserGreetingEventGreeting.md +++ b/build/docs/UserGreetingEventGreeting.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserGreetingEventGreetingAudioFile.md b/build/docs/UserGreetingEventGreetingAudioFile.md index 87d58bae5..2417a1d45 100644 --- a/build/docs/UserGreetingEventGreetingAudioFile.md +++ b/build/docs/UserGreetingEventGreetingAudioFile.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserGreetingEventGreetingOwner.md b/build/docs/UserGreetingEventGreetingOwner.md index 204cce228..193a4ba63 100644 --- a/build/docs/UserGreetingEventGreetingOwner.md +++ b/build/docs/UserGreetingEventGreetingOwner.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserInsightsTrend.md b/build/docs/UserInsightsTrend.md index 3e3806fba..7c9ab5450 100644 --- a/build/docs/UserInsightsTrend.md +++ b/build/docs/UserInsightsTrend.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserInsightsTrendMetricItem.md b/build/docs/UserInsightsTrendMetricItem.md index 1dcc54d0a..acd85863b 100644 --- a/build/docs/UserInsightsTrendMetricItem.md +++ b/build/docs/UserInsightsTrendMetricItem.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserInsightsTrendTotalItem.md b/build/docs/UserInsightsTrendTotalItem.md index 44250a544..3797fe867 100644 --- a/build/docs/UserInsightsTrendTotalItem.md +++ b/build/docs/UserInsightsTrendTotalItem.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserInsightsTrends.md b/build/docs/UserInsightsTrends.md index a3b46986c..7c737aded 100644 --- a/build/docs/UserInsightsTrends.md +++ b/build/docs/UserInsightsTrends.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserLanguageEntityListing.md b/build/docs/UserLanguageEntityListing.md index 7dfde4bd1..1d7f52ba3 100644 --- a/build/docs/UserLanguageEntityListing.md +++ b/build/docs/UserLanguageEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserLicenses.md b/build/docs/UserLicenses.md index 40a5ad810..476cf3ce9 100644 --- a/build/docs/UserLicenses.md +++ b/build/docs/UserLicenses.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserLicensesEntityListing.md b/build/docs/UserLicensesEntityListing.md index 915e39944..79cdec5b7 100644 --- a/build/docs/UserLicensesEntityListing.md +++ b/build/docs/UserLicensesEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserListScheduleRequestBody.md b/build/docs/UserListScheduleRequestBody.md index 561b6b3a2..51038eee0 100644 --- a/build/docs/UserListScheduleRequestBody.md +++ b/build/docs/UserListScheduleRequestBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserMe.md b/build/docs/UserMe.md index daf587a93..0255c0eb2 100644 --- a/build/docs/UserMe.md +++ b/build/docs/UserMe.md @@ -64,4 +64,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserNextActivityReminder.md b/build/docs/UserNextActivityReminder.md index 61c23e5da..4bb1229c2 100644 --- a/build/docs/UserNextActivityReminder.md +++ b/build/docs/UserNextActivityReminder.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserObservationDataContainer.md b/build/docs/UserObservationDataContainer.md index 2738c0473..9328c6817 100644 --- a/build/docs/UserObservationDataContainer.md +++ b/build/docs/UserObservationDataContainer.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserObservationQuery.md b/build/docs/UserObservationQuery.md index 3fc76d57a..cd607ab82 100644 --- a/build/docs/UserObservationQuery.md +++ b/build/docs/UserObservationQuery.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserObservationQueryClause.md b/build/docs/UserObservationQueryClause.md index 1cb7e3edf..bd2fcfc87 100644 --- a/build/docs/UserObservationQueryClause.md +++ b/build/docs/UserObservationQueryClause.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserObservationQueryFilter.md b/build/docs/UserObservationQueryFilter.md index 969988025..23b2b4864 100644 --- a/build/docs/UserObservationQueryFilter.md +++ b/build/docs/UserObservationQueryFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserObservationQueryPredicate.md b/build/docs/UserObservationQueryPredicate.md index e7572446f..10f8cd8d4 100644 --- a/build/docs/UserObservationQueryPredicate.md +++ b/build/docs/UserObservationQueryPredicate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserObservationQueryResponse.md b/build/docs/UserObservationQueryResponse.md index 6a9b866de..90e7bd076 100644 --- a/build/docs/UserObservationQueryResponse.md +++ b/build/docs/UserObservationQueryResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserParam.md b/build/docs/UserParam.md index 16a3f594d..5893101db 100644 --- a/build/docs/UserParam.md +++ b/build/docs/UserParam.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserPresence.md b/build/docs/UserPresence.md index 907d2fb7f..04573418d 100644 --- a/build/docs/UserPresence.md +++ b/build/docs/UserPresence.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserPresenceEvent.md b/build/docs/UserPresenceEvent.md index f80805931..fae9ec30d 100644 --- a/build/docs/UserPresenceEvent.md +++ b/build/docs/UserPresenceEvent.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserPrimarySource.md b/build/docs/UserPrimarySource.md index 4e70d55c5..374012441 100644 --- a/build/docs/UserPrimarySource.md +++ b/build/docs/UserPrimarySource.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserProfile.md b/build/docs/UserProfile.md index 28e2de69b..9a8ccf88d 100644 --- a/build/docs/UserProfile.md +++ b/build/docs/UserProfile.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserProfileEntityListing.md b/build/docs/UserProfileEntityListing.md index 005f6616a..46a567a98 100644 --- a/build/docs/UserProfileEntityListing.md +++ b/build/docs/UserProfileEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserProfilesInDateRange.md b/build/docs/UserProfilesInDateRange.md index e4f84c627..696b2c937 100644 --- a/build/docs/UserProfilesInDateRange.md +++ b/build/docs/UserProfilesInDateRange.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserProfilesInDateRangeRequest.md b/build/docs/UserProfilesInDateRangeRequest.md index 84939c18d..c5a8a6c04 100644 --- a/build/docs/UserProfilesInDateRangeRequest.md +++ b/build/docs/UserProfilesInDateRangeRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserQueue.md b/build/docs/UserQueue.md index de9c5f45c..8d204e545 100644 --- a/build/docs/UserQueue.md +++ b/build/docs/UserQueue.md @@ -48,4 +48,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserQueueEntityListing.md b/build/docs/UserQueueEntityListing.md index cde395c34..d5787526d 100644 --- a/build/docs/UserQueueEntityListing.md +++ b/build/docs/UserQueueEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRecording.md b/build/docs/UserRecording.md index ead983bd1..be9baf63a 100644 --- a/build/docs/UserRecording.md +++ b/build/docs/UserRecording.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRecordingEntityListing.md b/build/docs/UserRecordingEntityListing.md index 22e844a2c..44b59dfe7 100644 --- a/build/docs/UserRecordingEntityListing.md +++ b/build/docs/UserRecordingEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRecordingsAPI.md b/build/docs/UserRecordingsAPI.md index e9c312b1e..4540ca285 100644 --- a/build/docs/UserRecordingsAPI.md +++ b/build/docs/UserRecordingsAPI.md @@ -371,4 +371,4 @@ UserRecordingsAPI.putUserrecording(recordingId: recordingId, body: body, expand: [**UserRecording**](UserRecording) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserReference.md b/build/docs/UserReference.md index e53977f0f..2961bb724 100644 --- a/build/docs/UserReference.md +++ b/build/docs/UserReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserReferenceEntityListing.md b/build/docs/UserReferenceEntityListing.md index 262b1c37f..853058fc8 100644 --- a/build/docs/UserReferenceEntityListing.md +++ b/build/docs/UserReferenceEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserReferenceWithName.md b/build/docs/UserReferenceWithName.md index e802e61f2..d250a6d68 100644 --- a/build/docs/UserReferenceWithName.md +++ b/build/docs/UserReferenceWithName.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingLanguage.md b/build/docs/UserRoutingLanguage.md index cdd1b1c5a..759df0dc9 100644 --- a/build/docs/UserRoutingLanguage.md +++ b/build/docs/UserRoutingLanguage.md @@ -16,4 +16,4 @@ Represents an organization language assigned to a user. When assigning to a user -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingLanguagePost.md b/build/docs/UserRoutingLanguagePost.md index 4494696fc..fd32919c4 100644 --- a/build/docs/UserRoutingLanguagePost.md +++ b/build/docs/UserRoutingLanguagePost.md @@ -14,4 +14,4 @@ Represents an organization language assigned to a user. When assigning to a user -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingSkill.md b/build/docs/UserRoutingSkill.md index a744b8493..00d6f6286 100644 --- a/build/docs/UserRoutingSkill.md +++ b/build/docs/UserRoutingSkill.md @@ -16,4 +16,4 @@ Represents an organization skill assigned to a user. When assigning to a user sp -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingSkillPost.md b/build/docs/UserRoutingSkillPost.md index 685265d7b..9e09b6d6d 100644 --- a/build/docs/UserRoutingSkillPost.md +++ b/build/docs/UserRoutingSkillPost.md @@ -14,4 +14,4 @@ Represents an organization skill assigned to a user. When assigning to a user sp -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingStatusErrorInfo.md b/build/docs/UserRoutingStatusErrorInfo.md index 44e537a97..4ab151e02 100644 --- a/build/docs/UserRoutingStatusErrorInfo.md +++ b/build/docs/UserRoutingStatusErrorInfo.md @@ -16,4 +16,4 @@ Error information that the Public API will receive in a response body. This allo -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingStatusEvent.md b/build/docs/UserRoutingStatusEvent.md index 3440fdf3b..572ab82a1 100644 --- a/build/docs/UserRoutingStatusEvent.md +++ b/build/docs/UserRoutingStatusEvent.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingStatusObject.md b/build/docs/UserRoutingStatusObject.md index 778f6a46a..52cf11d88 100644 --- a/build/docs/UserRoutingStatusObject.md +++ b/build/docs/UserRoutingStatusObject.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingStatusRoutingStatus.md b/build/docs/UserRoutingStatusRoutingStatus.md index b2f65b9a0..e297e2d1d 100644 --- a/build/docs/UserRoutingStatusRoutingStatus.md +++ b/build/docs/UserRoutingStatusRoutingStatus.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingStatusUserParam.md b/build/docs/UserRoutingStatusUserParam.md index f00ef46ea..6300376fb 100644 --- a/build/docs/UserRoutingStatusUserParam.md +++ b/build/docs/UserRoutingStatusUserParam.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserRoutingStatusUserRoutingStatus.md b/build/docs/UserRoutingStatusUserRoutingStatus.md index 62b03ced4..1684f78ef 100644 --- a/build/docs/UserRoutingStatusUserRoutingStatus.md +++ b/build/docs/UserRoutingStatusUserRoutingStatus.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserSchedule.md b/build/docs/UserSchedule.md index 9ac3cd282..35e934ce3 100644 --- a/build/docs/UserSchedule.md +++ b/build/docs/UserSchedule.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserScheduleActivity.md b/build/docs/UserScheduleActivity.md index d56b4dff6..8767db8bc 100644 --- a/build/docs/UserScheduleActivity.md +++ b/build/docs/UserScheduleActivity.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserScheduleAdherence.md b/build/docs/UserScheduleAdherence.md index 064cbe9bc..534937e32 100644 --- a/build/docs/UserScheduleAdherence.md +++ b/build/docs/UserScheduleAdherence.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserScheduleAdherenceListing.md b/build/docs/UserScheduleAdherenceListing.md index dd9b4ab77..1f6fee030 100644 --- a/build/docs/UserScheduleAdherenceListing.md +++ b/build/docs/UserScheduleAdherenceListing.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserScheduleContainer.md b/build/docs/UserScheduleContainer.md index 898af4e90..5a19fc781 100644 --- a/build/docs/UserScheduleContainer.md +++ b/build/docs/UserScheduleContainer.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserScheduleFullDayTimeOffMarker.md b/build/docs/UserScheduleFullDayTimeOffMarker.md index 491a0b097..06b1fd5e6 100644 --- a/build/docs/UserScheduleFullDayTimeOffMarker.md +++ b/build/docs/UserScheduleFullDayTimeOffMarker.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserScheduleShift.md b/build/docs/UserScheduleShift.md index 7a4173d5a..c585e6e4e 100644 --- a/build/docs/UserScheduleShift.md +++ b/build/docs/UserScheduleShift.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserSearchCriteria.md b/build/docs/UserSearchCriteria.md index f717892a4..a73c153d4 100644 --- a/build/docs/UserSearchCriteria.md +++ b/build/docs/UserSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserSearchRequest.md b/build/docs/UserSearchRequest.md index 3d2d3f1de..947ca5472 100644 --- a/build/docs/UserSearchRequest.md +++ b/build/docs/UserSearchRequest.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserSearchRule.md b/build/docs/UserSearchRule.md index a484c16bd..8851e58e2 100644 --- a/build/docs/UserSearchRule.md +++ b/build/docs/UserSearchRule.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserSearchRulePart.md b/build/docs/UserSearchRulePart.md index a29a6479c..5164e33da 100644 --- a/build/docs/UserSearchRulePart.md +++ b/build/docs/UserSearchRulePart.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserSkillEntityListing.md b/build/docs/UserSkillEntityListing.md index 8120044e5..a753f8bdb 100644 --- a/build/docs/UserSkillEntityListing.md +++ b/build/docs/UserSkillEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserSkillGroupEntityListing.md b/build/docs/UserSkillGroupEntityListing.md index 9022cfc91..01900800e 100644 --- a/build/docs/UserSkillGroupEntityListing.md +++ b/build/docs/UserSkillGroupEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserStaffingGroupListing.md b/build/docs/UserStaffingGroupListing.md index 22e4f6743..df34918b6 100644 --- a/build/docs/UserStaffingGroupListing.md +++ b/build/docs/UserStaffingGroupListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserStaffingGroupResponse.md b/build/docs/UserStaffingGroupResponse.md index a3e4ae6bf..9e75b1831 100644 --- a/build/docs/UserStaffingGroupResponse.md +++ b/build/docs/UserStaffingGroupResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserStartDetailEventTopicUserStartEvent.md b/build/docs/UserStartDetailEventTopicUserStartEvent.md index f1fac80d0..a62f3a029 100644 --- a/build/docs/UserStartDetailEventTopicUserStartEvent.md +++ b/build/docs/UserStartDetailEventTopicUserStartEvent.md @@ -30,4 +30,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserState.md b/build/docs/UserState.md index 8a2da61fb..541f05ca4 100644 --- a/build/docs/UserState.md +++ b/build/docs/UserState.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserStation.md b/build/docs/UserStation.md index 2456d8461..62b9ce118 100644 --- a/build/docs/UserStation.md +++ b/build/docs/UserStation.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserStationChangeTopicUser.md b/build/docs/UserStationChangeTopicUser.md index 5a24daa84..234a62f09 100644 --- a/build/docs/UserStationChangeTopicUser.md +++ b/build/docs/UserStationChangeTopicUser.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserStationChangeTopicUserStation.md b/build/docs/UserStationChangeTopicUserStation.md index bc7716f6b..4a112963b 100644 --- a/build/docs/UserStationChangeTopicUserStation.md +++ b/build/docs/UserStationChangeTopicUserStation.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserStationChangeTopicUserStations.md b/build/docs/UserStationChangeTopicUserStations.md index 868fbe663..9fb28b2e3 100644 --- a/build/docs/UserStationChangeTopicUserStations.md +++ b/build/docs/UserStationChangeTopicUserStations.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserStations.md b/build/docs/UserStations.md index 5bc95af9e..3fe645072 100644 --- a/build/docs/UserStations.md +++ b/build/docs/UserStations.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserTimeOffIntegrationStatusResponse.md b/build/docs/UserTimeOffIntegrationStatusResponse.md index 768b560c0..88d9c1d54 100644 --- a/build/docs/UserTimeOffIntegrationStatusResponse.md +++ b/build/docs/UserTimeOffIntegrationStatusResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserTimeOffIntegrationStatusResponseListing.md b/build/docs/UserTimeOffIntegrationStatusResponseListing.md index b38dee762..923ff0d8e 100644 --- a/build/docs/UserTimeOffIntegrationStatusResponseListing.md +++ b/build/docs/UserTimeOffIntegrationStatusResponseListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserTimeOffRequestReference.md b/build/docs/UserTimeOffRequestReference.md index 6f9f43622..0be249570 100644 --- a/build/docs/UserTimeOffRequestReference.md +++ b/build/docs/UserTimeOffRequestReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserTokensTopicTokenNotification.md b/build/docs/UserTokensTopicTokenNotification.md index e05031666..d49ee9c93 100644 --- a/build/docs/UserTokensTopicTokenNotification.md +++ b/build/docs/UserTokensTopicTokenNotification.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserTokensTopicUriReference.md b/build/docs/UserTokensTopicUriReference.md index 5ff2bdfaf..b78bdb1aa 100644 --- a/build/docs/UserTokensTopicUriReference.md +++ b/build/docs/UserTokensTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserTransferEvent.md b/build/docs/UserTransferEvent.md index f165b8d5a..154ce8765 100644 --- a/build/docs/UserTransferEvent.md +++ b/build/docs/UserTransferEvent.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserTrendData.md b/build/docs/UserTrendData.md index b89a8fbd9..d116c2303 100644 --- a/build/docs/UserTrendData.md +++ b/build/docs/UserTrendData.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UserVideoSettings.md b/build/docs/UserVideoSettings.md index 7dc248149..5bdc4dc55 100644 --- a/build/docs/UserVideoSettings.md +++ b/build/docs/UserVideoSettings.md @@ -12,4 +12,4 @@ The settings for User Video -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UsersAPI.md b/build/docs/UsersAPI.md index 5f6a0bcaa..3b1598070 100644 --- a/build/docs/UsersAPI.md +++ b/build/docs/UsersAPI.md @@ -4988,4 +4988,4 @@ UsersAPI.putUserVerifier(userId: userId, verifierId: verifierId, body: body) { ( [**Verifier**](Verifier) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UsersSearchResponse.md b/build/docs/UsersSearchResponse.md index b43ff10c1..c67a8b71c 100644 --- a/build/docs/UsersSearchResponse.md +++ b/build/docs/UsersSearchResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UtilitiesAPI.md b/build/docs/UtilitiesAPI.md index e134e0bc0..f8413ca20 100644 --- a/build/docs/UtilitiesAPI.md +++ b/build/docs/UtilitiesAPI.md @@ -201,4 +201,4 @@ UtilitiesAPI.postCertificateDetails(body: body) { (response, error) in [**ParsedCertificate**](ParsedCertificate) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UtilizationLabel.md b/build/docs/UtilizationLabel.md index b0b88f327..962064ad4 100644 --- a/build/docs/UtilizationLabel.md +++ b/build/docs/UtilizationLabel.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UtilizationLabelEntityListing.md b/build/docs/UtilizationLabelEntityListing.md index f5160f1a1..d844affb3 100644 --- a/build/docs/UtilizationLabelEntityListing.md +++ b/build/docs/UtilizationLabelEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UtilizationRequest.md b/build/docs/UtilizationRequest.md index 69bba9c47..a3bf34a13 100644 --- a/build/docs/UtilizationRequest.md +++ b/build/docs/UtilizationRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/UtilizationResponse.md b/build/docs/UtilizationResponse.md index 1cf5558f6..489034afa 100644 --- a/build/docs/UtilizationResponse.md +++ b/build/docs/UtilizationResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Utterance.md b/build/docs/Utterance.md index e54a2196f..a7761e77d 100644 --- a/build/docs/Utterance.md +++ b/build/docs/Utterance.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationEventTyping.md b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationEventTyping.md index 32063c950..8abd72134 100644 --- a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationEventTyping.md +++ b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationEventTyping.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessageEvent.md b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessageEvent.md index b2a4871e7..626c94866 100644 --- a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessageEvent.md +++ b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessageEvent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel.md b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel.md index 8e3e13cb1..f4fd0c76c 100644 --- a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel.md +++ b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingChannel.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient.md b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient.md index a691194ad..dc30820ab 100644 --- a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient.md +++ b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingFromRecipient.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient.md b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient.md index 400d4123d..9f08ea99e 100644 --- a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient.md +++ b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationMessagingToRecipient.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage.md b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage.md index b3fa22a03..d22398554 100644 --- a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage.md +++ b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationNormalizedMessage.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier.md b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier.md index 1f02368f4..ab1f27a0d 100644 --- a/build/docs/V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier.md +++ b/build/docs/V2ConversationMessageTypingEventForUserTopicConversationRecipientAdditionalIdentifier.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForUserTopicMessageData.md b/build/docs/V2ConversationMessageTypingEventForUserTopicMessageData.md index 371b81590..8a698017c 100644 --- a/build/docs/V2ConversationMessageTypingEventForUserTopicMessageData.md +++ b/build/docs/V2ConversationMessageTypingEventForUserTopicMessageData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping.md b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping.md index 247397b65..23e622d7c 100644 --- a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping.md +++ b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationEventTyping.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent.md b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent.md index 11f7ab8c5..2cbac6bb6 100644 --- a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent.md +++ b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessageEvent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel.md b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel.md index d2b5b9924..1b4a4e835 100644 --- a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel.md +++ b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingChannel.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient.md b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient.md index 094fd549c..78e9d858e 100644 --- a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient.md +++ b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingFromRecipient.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient.md b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient.md index 3ac3080f6..03fbbeb75 100644 --- a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient.md +++ b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage.md b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage.md index ff906260e..802b70a05 100644 --- a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage.md +++ b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier.md b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier.md index e636ff2e1..ff4032e61 100644 --- a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier.md +++ b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicConversationRecipientAdditionalIdentifier.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicMessageData.md b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicMessageData.md index a722e8029..814f0077e 100644 --- a/build/docs/V2ConversationMessageTypingEventForWorkflowTopicMessageData.md +++ b/build/docs/V2ConversationMessageTypingEventForWorkflowTopicMessageData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicExecution.md b/build/docs/V2FlowExecutionDataFlowidTopicExecution.md index e9dd5e4e1..d433d8a62 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicExecution.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicExecution.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicFlow.md b/build/docs/V2FlowExecutionDataFlowidTopicFlow.md index ae37e0c52..9b2203b59 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicFlow.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicFlow.md @@ -12,4 +12,4 @@ This contains information about the flow that invoked this execution. Both a fl -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicFlowErrorWarningInfo.md b/build/docs/V2FlowExecutionDataFlowidTopicFlowErrorWarningInfo.md index 19b020c84..3acf1380a 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicFlowErrorWarningInfo.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicFlowErrorWarningInfo.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicFlowExecutionHistory.md b/build/docs/V2FlowExecutionDataFlowidTopicFlowExecutionHistory.md index 0df4efdbf..e22854a16 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicFlowExecutionHistory.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicFlowExecutionHistory.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicInvokingContext.md b/build/docs/V2FlowExecutionDataFlowidTopicInvokingContext.md index 896236c23..f9b97bc76 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicInvokingContext.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicInvokingContext.md @@ -15,4 +15,4 @@ This contains contextual information about an invoking entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicJourneyActionMap.md b/build/docs/V2FlowExecutionDataFlowidTopicJourneyActionMap.md index a86309332..df6c11ff8 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicJourneyActionMap.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicJourneyActionMap.md @@ -12,4 +12,4 @@ This contains contextual information about an invoking entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicProcessAutomation.md b/build/docs/V2FlowExecutionDataFlowidTopicProcessAutomation.md index 7130252d1..9a6dafe1d 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicProcessAutomation.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicProcessAutomation.md @@ -12,4 +12,4 @@ This contains contextual information about an invoking entity. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicQuality.md b/build/docs/V2FlowExecutionDataFlowidTopicQuality.md index 9a041ecde..d81143fcf 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicQuality.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicQuality.md @@ -12,4 +12,4 @@ The quality context that invoked this. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2FlowExecutionDataFlowidTopicWorkitem.md b/build/docs/V2FlowExecutionDataFlowidTopicWorkitem.md index 85c60d27d..173cb8e94 100644 --- a/build/docs/V2FlowExecutionDataFlowidTopicWorkitem.md +++ b/build/docs/V2FlowExecutionDataFlowidTopicWorkitem.md @@ -12,4 +12,4 @@ This contains information about the workitem that invoked this flow execution. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2IntegrationPresenceEventOrganizationPresence.md b/build/docs/V2IntegrationPresenceEventOrganizationPresence.md index 09377bdcf..1bbbd84f0 100644 --- a/build/docs/V2IntegrationPresenceEventOrganizationPresence.md +++ b/build/docs/V2IntegrationPresenceEventOrganizationPresence.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2IntegrationPresenceEventPresenceActivityEvent.md b/build/docs/V2IntegrationPresenceEventPresenceActivityEvent.md index 528d83f0d..c3a3ff6ea 100644 --- a/build/docs/V2IntegrationPresenceEventPresenceActivityEvent.md +++ b/build/docs/V2IntegrationPresenceEventPresenceActivityEvent.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicAddressableEntityRef.md b/build/docs/V2MobiusAlertsTopicAddressableEntityRef.md index dce56882c..072b6d9e5 100644 --- a/build/docs/V2MobiusAlertsTopicAddressableEntityRef.md +++ b/build/docs/V2MobiusAlertsTopicAddressableEntityRef.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicAlert.md b/build/docs/V2MobiusAlertsTopicAlert.md index 329d2a65f..67fd938f1 100644 --- a/build/docs/V2MobiusAlertsTopicAlert.md +++ b/build/docs/V2MobiusAlertsTopicAlert.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicAlertNotification.md b/build/docs/V2MobiusAlertsTopicAlertNotification.md index 160e967a9..e160422bc 100644 --- a/build/docs/V2MobiusAlertsTopicAlertNotification.md +++ b/build/docs/V2MobiusAlertsTopicAlertNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicAlertNotificationRecipient.md b/build/docs/V2MobiusAlertsTopicAlertNotificationRecipient.md index f7349f0f7..894e3f941 100644 --- a/build/docs/V2MobiusAlertsTopicAlertNotificationRecipient.md +++ b/build/docs/V2MobiusAlertsTopicAlertNotificationRecipient.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicAlertRuleProperties.md b/build/docs/V2MobiusAlertsTopicAlertRuleProperties.md index 7f38bd836..5764b3244 100644 --- a/build/docs/V2MobiusAlertsTopicAlertRuleProperties.md +++ b/build/docs/V2MobiusAlertsTopicAlertRuleProperties.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicAlertSummary.md b/build/docs/V2MobiusAlertsTopicAlertSummary.md index 57d3f1fce..d7c2221ac 100644 --- a/build/docs/V2MobiusAlertsTopicAlertSummary.md +++ b/build/docs/V2MobiusAlertsTopicAlertSummary.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicAlertSummaryEntity.md b/build/docs/V2MobiusAlertsTopicAlertSummaryEntity.md index 79b4e65d3..36bfa0ab7 100644 --- a/build/docs/V2MobiusAlertsTopicAlertSummaryEntity.md +++ b/build/docs/V2MobiusAlertsTopicAlertSummaryEntity.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicAlertingAddressableEntityRef.md b/build/docs/V2MobiusAlertsTopicAlertingAddressableEntityRef.md index 947ca6687..9006033e2 100644 --- a/build/docs/V2MobiusAlertsTopicAlertingAddressableEntityRef.md +++ b/build/docs/V2MobiusAlertsTopicAlertingAddressableEntityRef.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicCondition.md b/build/docs/V2MobiusAlertsTopicCondition.md index 89dd08acd..b4ae3fa23 100644 --- a/build/docs/V2MobiusAlertsTopicCondition.md +++ b/build/docs/V2MobiusAlertsTopicCondition.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicConditionRulePredicate.md b/build/docs/V2MobiusAlertsTopicConditionRulePredicate.md index 95c5cf9ba..ee9e533a7 100644 --- a/build/docs/V2MobiusAlertsTopicConditionRulePredicate.md +++ b/build/docs/V2MobiusAlertsTopicConditionRulePredicate.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusAlertsTopicEntityProperties.md b/build/docs/V2MobiusAlertsTopicEntityProperties.md index 8d9cf1121..351e2f89d 100644 --- a/build/docs/V2MobiusAlertsTopicEntityProperties.md +++ b/build/docs/V2MobiusAlertsTopicEntityProperties.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusRulesTopicAlertNotification.md b/build/docs/V2MobiusRulesTopicAlertNotification.md index 438ec0334..de5033f34 100644 --- a/build/docs/V2MobiusRulesTopicAlertNotification.md +++ b/build/docs/V2MobiusRulesTopicAlertNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusRulesTopicAlertNotificationRecipient.md b/build/docs/V2MobiusRulesTopicAlertNotificationRecipient.md index 012eae285..97901b189 100644 --- a/build/docs/V2MobiusRulesTopicAlertNotificationRecipient.md +++ b/build/docs/V2MobiusRulesTopicAlertNotificationRecipient.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusRulesTopicAlertingAddressableEntityRef.md b/build/docs/V2MobiusRulesTopicAlertingAddressableEntityRef.md index 7f2d74d1b..0ff2c2376 100644 --- a/build/docs/V2MobiusRulesTopicAlertingAddressableEntityRef.md +++ b/build/docs/V2MobiusRulesTopicAlertingAddressableEntityRef.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusRulesTopicCondition.md b/build/docs/V2MobiusRulesTopicCondition.md index 59d6aa691..cb2b10915 100644 --- a/build/docs/V2MobiusRulesTopicCondition.md +++ b/build/docs/V2MobiusRulesTopicCondition.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusRulesTopicConditionRulePredicate.md b/build/docs/V2MobiusRulesTopicConditionRulePredicate.md index b9370a215..d643f532b 100644 --- a/build/docs/V2MobiusRulesTopicConditionRulePredicate.md +++ b/build/docs/V2MobiusRulesTopicConditionRulePredicate.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusRulesTopicEntityProperties.md b/build/docs/V2MobiusRulesTopicEntityProperties.md index 6a42673c8..fafe44089 100644 --- a/build/docs/V2MobiusRulesTopicEntityProperties.md +++ b/build/docs/V2MobiusRulesTopicEntityProperties.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2MobiusRulesTopicRule.md b/build/docs/V2MobiusRulesTopicRule.md index 8ee3d2c48..7e31f120f 100644 --- a/build/docs/V2MobiusRulesTopicRule.md +++ b/build/docs/V2MobiusRulesTopicRule.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2WebMessagingUndeliveredMessageTopicMessage.md b/build/docs/V2WebMessagingUndeliveredMessageTopicMessage.md index 8bb90e0f8..360f761d1 100644 --- a/build/docs/V2WebMessagingUndeliveredMessageTopicMessage.md +++ b/build/docs/V2WebMessagingUndeliveredMessageTopicMessage.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2WebMessagingUndeliveredMessageTopicWebMessagingUndeliveredMessageEventBody.md b/build/docs/V2WebMessagingUndeliveredMessageTopicWebMessagingUndeliveredMessageEventBody.md index bfdb1abe7..a8659151c 100644 --- a/build/docs/V2WebMessagingUndeliveredMessageTopicWebMessagingUndeliveredMessageEventBody.md +++ b/build/docs/V2WebMessagingUndeliveredMessageTopicWebMessagingUndeliveredMessageEventBody.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2WemEngagementCelebrationUpdatesTopicEngagementCelebration.md b/build/docs/V2WemEngagementCelebrationUpdatesTopicEngagementCelebration.md index 3e6501841..1133cb69d 100644 --- a/build/docs/V2WemEngagementCelebrationUpdatesTopicEngagementCelebration.md +++ b/build/docs/V2WemEngagementCelebrationUpdatesTopicEngagementCelebration.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2WemEngagementCelebrationUpdatesTopicSourceEntity.md b/build/docs/V2WemEngagementCelebrationUpdatesTopicSourceEntity.md index 50860c56e..6a5218404 100644 --- a/build/docs/V2WemEngagementCelebrationUpdatesTopicSourceEntity.md +++ b/build/docs/V2WemEngagementCelebrationUpdatesTopicSourceEntity.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/V2WemEngagementCelebrationUpdatesTopicUserId.md b/build/docs/V2WemEngagementCelebrationUpdatesTopicUserId.md index c3917ef76..db19ee519 100644 --- a/build/docs/V2WemEngagementCelebrationUpdatesTopicUserId.md +++ b/build/docs/V2WemEngagementCelebrationUpdatesTopicUserId.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidateAddressRequest.md b/build/docs/ValidateAddressRequest.md index e389ed06a..188153b9c 100644 --- a/build/docs/ValidateAddressRequest.md +++ b/build/docs/ValidateAddressRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidateAddressResponse.md b/build/docs/ValidateAddressResponse.md index e10b6060e..c5793ca75 100644 --- a/build/docs/ValidateAddressResponse.md +++ b/build/docs/ValidateAddressResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidateAssignUsers.md b/build/docs/ValidateAssignUsers.md index d707362ab..a5185f06c 100644 --- a/build/docs/ValidateAssignUsers.md +++ b/build/docs/ValidateAssignUsers.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidateWorkPlanMessages.md b/build/docs/ValidateWorkPlanMessages.md index 8ac9649a1..e38f6dbbc 100644 --- a/build/docs/ValidateWorkPlanMessages.md +++ b/build/docs/ValidateWorkPlanMessages.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidateWorkPlanResponse.md b/build/docs/ValidateWorkPlanResponse.md index e1e23e3f8..3ba170f86 100644 --- a/build/docs/ValidateWorkPlanResponse.md +++ b/build/docs/ValidateWorkPlanResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidationError.md b/build/docs/ValidationError.md index 999098711..7e0b5373d 100644 --- a/build/docs/ValidationError.md +++ b/build/docs/ValidationError.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidationLimits.md b/build/docs/ValidationLimits.md index a05f74a94..e9b6ee2dd 100644 --- a/build/docs/ValidationLimits.md +++ b/build/docs/ValidationLimits.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidationResult.md b/build/docs/ValidationResult.md index e9be80ec3..d53514ac5 100644 --- a/build/docs/ValidationResult.md +++ b/build/docs/ValidationResult.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValidationServiceRequest.md b/build/docs/ValidationServiceRequest.md index 9ee5a0c58..bf7dea51a 100644 --- a/build/docs/ValidationServiceRequest.md +++ b/build/docs/ValidationServiceRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValueWrapperActivityPlanServiceGoalImpactOverrides.md b/build/docs/ValueWrapperActivityPlanServiceGoalImpactOverrides.md index b07f3c0e2..c574223aa 100644 --- a/build/docs/ValueWrapperActivityPlanServiceGoalImpactOverrides.md +++ b/build/docs/ValueWrapperActivityPlanServiceGoalImpactOverrides.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValueWrapperDate.md b/build/docs/ValueWrapperDate.md index b7b495daf..afb6ec477 100644 --- a/build/docs/ValueWrapperDate.md +++ b/build/docs/ValueWrapperDate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValueWrapperGroupSettings.md b/build/docs/ValueWrapperGroupSettings.md index be3b5d32b..79db4eeb9 100644 --- a/build/docs/ValueWrapperGroupSettings.md +++ b/build/docs/ValueWrapperGroupSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValueWrapperHrisTimeOffType.md b/build/docs/ValueWrapperHrisTimeOffType.md index 0f92438e7..1994b97db 100644 --- a/build/docs/ValueWrapperHrisTimeOffType.md +++ b/build/docs/ValueWrapperHrisTimeOffType.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValueWrapperMonthlyPlanningPeriodSettings.md b/build/docs/ValueWrapperMonthlyPlanningPeriodSettings.md index 1c8b13803..d341c6d70 100644 --- a/build/docs/ValueWrapperMonthlyPlanningPeriodSettings.md +++ b/build/docs/ValueWrapperMonthlyPlanningPeriodSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValueWrapperPlanningPeriodSettings.md b/build/docs/ValueWrapperPlanningPeriodSettings.md index 8ee3d4d93..0d0581846 100644 --- a/build/docs/ValueWrapperPlanningPeriodSettings.md +++ b/build/docs/ValueWrapperPlanningPeriodSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValueWrapperString.md b/build/docs/ValueWrapperString.md index 886f1cf13..7dc746f32 100644 --- a/build/docs/ValueWrapperString.md +++ b/build/docs/ValueWrapperString.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ValueWrapperUserSearchRule.md b/build/docs/ValueWrapperUserSearchRule.md index a1a103440..f65647aa9 100644 --- a/build/docs/ValueWrapperUserSearchRule.md +++ b/build/docs/ValueWrapperUserSearchRule.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VerificationResult.md b/build/docs/VerificationResult.md index ba8efc212..ffff88654 100644 --- a/build/docs/VerificationResult.md +++ b/build/docs/VerificationResult.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Verifier.md b/build/docs/Verifier.md index cd713845c..161ce8c44 100644 --- a/build/docs/Verifier.md +++ b/build/docs/Verifier.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VerifierEntityListing.md b/build/docs/VerifierEntityListing.md index 842b0c525..820d9b778 100644 --- a/build/docs/VerifierEntityListing.md +++ b/build/docs/VerifierEntityListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Video.md b/build/docs/Video.md index 2f942c52f..41234bd91 100644 --- a/build/docs/Video.md +++ b/build/docs/Video.md @@ -28,4 +28,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VideoConferenceUpdateTopicParticipantInfo.md b/build/docs/VideoConferenceUpdateTopicParticipantInfo.md index 3e570c509..a9d69b3a7 100644 --- a/build/docs/VideoConferenceUpdateTopicParticipantInfo.md +++ b/build/docs/VideoConferenceUpdateTopicParticipantInfo.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VideoConferenceUpdateTopicVideoConference.md b/build/docs/VideoConferenceUpdateTopicVideoConference.md index 3fe78428f..17f259091 100644 --- a/build/docs/VideoConferenceUpdateTopicVideoConference.md +++ b/build/docs/VideoConferenceUpdateTopicVideoConference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VideoSettings.md b/build/docs/VideoSettings.md index c4ff54fbc..414be1286 100644 --- a/build/docs/VideoSettings.md +++ b/build/docs/VideoSettings.md @@ -13,4 +13,4 @@ The settings to enable video chat -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/ViewFilter.md b/build/docs/ViewFilter.md index 34f7d8bec..ca169934a 100644 --- a/build/docs/ViewFilter.md +++ b/build/docs/ViewFilter.md @@ -221,4 +221,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VisibilityCondition.md b/build/docs/VisibilityCondition.md index 2db75d541..9f485ce3e 100644 --- a/build/docs/VisibilityCondition.md +++ b/build/docs/VisibilityCondition.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VmPairingInfo.md b/build/docs/VmPairingInfo.md index c2b9ad3d0..e3ecba4b1 100644 --- a/build/docs/VmPairingInfo.md +++ b/build/docs/VmPairingInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Voicemail.md b/build/docs/Voicemail.md index a5c954100..8af3afa5d 100644 --- a/build/docs/Voicemail.md +++ b/build/docs/Voicemail.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailAPI.md b/build/docs/VoicemailAPI.md index 358bcccba..38541d408 100644 --- a/build/docs/VoicemailAPI.md +++ b/build/docs/VoicemailAPI.md @@ -1383,4 +1383,4 @@ VoicemailAPI.putVoicemailUserpolicy(userId: userId, body: body) { (response, err [**VoicemailUserPolicy**](VoicemailUserPolicy) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailCopyRecord.md b/build/docs/VoicemailCopyRecord.md index 635478d86..ffcc62a25 100644 --- a/build/docs/VoicemailCopyRecord.md +++ b/build/docs/VoicemailCopyRecord.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailEndDetailEventTopicVoicemailEndEvent.md b/build/docs/VoicemailEndDetailEventTopicVoicemailEndEvent.md index e7e3f59ac..982267e67 100644 --- a/build/docs/VoicemailEndDetailEventTopicVoicemailEndEvent.md +++ b/build/docs/VoicemailEndDetailEventTopicVoicemailEndEvent.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailGroupPolicy.md b/build/docs/VoicemailGroupPolicy.md index 80cdf84c6..50f0ad376 100644 --- a/build/docs/VoicemailGroupPolicy.md +++ b/build/docs/VoicemailGroupPolicy.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailMailboxInfo.md b/build/docs/VoicemailMailboxInfo.md index 523e860a5..c7a746a33 100644 --- a/build/docs/VoicemailMailboxInfo.md +++ b/build/docs/VoicemailMailboxInfo.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailMediaInfo.md b/build/docs/VoicemailMediaInfo.md index b91e765ad..1c95515e9 100644 --- a/build/docs/VoicemailMediaInfo.md +++ b/build/docs/VoicemailMediaInfo.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailMessage.md b/build/docs/VoicemailMessage.md index ee83ac1a1..2a628ff00 100644 --- a/build/docs/VoicemailMessage.md +++ b/build/docs/VoicemailMessage.md @@ -30,4 +30,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailMessageEntityListing.md b/build/docs/VoicemailMessageEntityListing.md index 9474b5e02..dfa553e9f 100644 --- a/build/docs/VoicemailMessageEntityListing.md +++ b/build/docs/VoicemailMessageEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailMessagesTopicOwner.md b/build/docs/VoicemailMessagesTopicOwner.md index 8688c3a3c..509b171b2 100644 --- a/build/docs/VoicemailMessagesTopicOwner.md +++ b/build/docs/VoicemailMessagesTopicOwner.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailMessagesTopicVoicemailCopyRecord.md b/build/docs/VoicemailMessagesTopicVoicemailCopyRecord.md index bc9380877..615d7b985 100644 --- a/build/docs/VoicemailMessagesTopicVoicemailCopyRecord.md +++ b/build/docs/VoicemailMessagesTopicVoicemailCopyRecord.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailMessagesTopicVoicemailMessage.md b/build/docs/VoicemailMessagesTopicVoicemailMessage.md index d2ffa3c4f..e7474a59d 100644 --- a/build/docs/VoicemailMessagesTopicVoicemailMessage.md +++ b/build/docs/VoicemailMessagesTopicVoicemailMessage.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailOrganizationPolicy.md b/build/docs/VoicemailOrganizationPolicy.md index 3256f7a10..f1bc3bc57 100644 --- a/build/docs/VoicemailOrganizationPolicy.md +++ b/build/docs/VoicemailOrganizationPolicy.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailRetentionPolicy.md b/build/docs/VoicemailRetentionPolicy.md index deea5b0d2..c5d19e653 100644 --- a/build/docs/VoicemailRetentionPolicy.md +++ b/build/docs/VoicemailRetentionPolicy.md @@ -12,4 +12,4 @@ Governs how the voicemail is retained -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailSearchCriteria.md b/build/docs/VoicemailSearchCriteria.md index ae243db6e..b6860ab88 100644 --- a/build/docs/VoicemailSearchCriteria.md +++ b/build/docs/VoicemailSearchCriteria.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailSearchRequest.md b/build/docs/VoicemailSearchRequest.md index 2efc74af4..ee6bba5d8 100644 --- a/build/docs/VoicemailSearchRequest.md +++ b/build/docs/VoicemailSearchRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailStartDetailEventTopicVoicemailStartEvent.md b/build/docs/VoicemailStartDetailEventTopicVoicemailStartEvent.md index e896308de..6d9fb8e9b 100644 --- a/build/docs/VoicemailStartDetailEventTopicVoicemailStartEvent.md +++ b/build/docs/VoicemailStartDetailEventTopicVoicemailStartEvent.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailUserPolicy.md b/build/docs/VoicemailUserPolicy.md index 45eeb8aa0..4e82dbaf6 100644 --- a/build/docs/VoicemailUserPolicy.md +++ b/build/docs/VoicemailUserPolicy.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/VoicemailsSearchResponse.md b/build/docs/VoicemailsSearchResponse.md index 99f756af0..62bcde948 100644 --- a/build/docs/VoicemailsSearchResponse.md +++ b/build/docs/VoicemailsSearchResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Void.md b/build/docs/Void.md index ab0a3ce86..a34df56c8 100644 --- a/build/docs/Void.md +++ b/build/docs/Void.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WaitlistPosition.md b/build/docs/WaitlistPosition.md index d07b029a4..467d7b888 100644 --- a/build/docs/WaitlistPosition.md +++ b/build/docs/WaitlistPosition.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WaitlistPositionListing.md b/build/docs/WaitlistPositionListing.md index 75588671f..796acc5db 100644 --- a/build/docs/WaitlistPositionListing.md +++ b/build/docs/WaitlistPositionListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Warning.md b/build/docs/Warning.md index 9476a9749..6b8d8e166 100644 --- a/build/docs/Warning.md +++ b/build/docs/Warning.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebActionEvent.md b/build/docs/WebActionEvent.md index 6623ea62b..a62e2e9a1 100644 --- a/build/docs/WebActionEvent.md +++ b/build/docs/WebActionEvent.md @@ -23,4 +23,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatAPI.md b/build/docs/WebChatAPI.md index 2e6c7b8ed..932375e43 100644 --- a/build/docs/WebChatAPI.md +++ b/build/docs/WebChatAPI.md @@ -990,4 +990,4 @@ WebChatAPI.putWebchatSettings(body: body) { (response, error) in [**WebChatSettings**](WebChatSettings) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatConfig.md b/build/docs/WebChatConfig.md index a3612a6b4..21a4f143d 100644 --- a/build/docs/WebChatConfig.md +++ b/build/docs/WebChatConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatConversation.md b/build/docs/WebChatConversation.md index 6812d48d5..eb58e5217 100644 --- a/build/docs/WebChatConversation.md +++ b/build/docs/WebChatConversation.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatDeployment.md b/build/docs/WebChatDeployment.md index 3a940cfa2..577f8853f 100644 --- a/build/docs/WebChatDeployment.md +++ b/build/docs/WebChatDeployment.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatDeploymentEntityListing.md b/build/docs/WebChatDeploymentEntityListing.md index a3d579379..ff5c1c604 100644 --- a/build/docs/WebChatDeploymentEntityListing.md +++ b/build/docs/WebChatDeploymentEntityListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatGuestMediaRequest.md b/build/docs/WebChatGuestMediaRequest.md index c22665bc9..fb5cbd2f6 100644 --- a/build/docs/WebChatGuestMediaRequest.md +++ b/build/docs/WebChatGuestMediaRequest.md @@ -17,4 +17,4 @@ Object representing the guest model of a media request of a chat conversation. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatGuestMediaRequestEntityList.md b/build/docs/WebChatGuestMediaRequestEntityList.md index 4afa91da8..bfb5892c8 100644 --- a/build/docs/WebChatGuestMediaRequestEntityList.md +++ b/build/docs/WebChatGuestMediaRequestEntityList.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatMemberInfo.md b/build/docs/WebChatMemberInfo.md index 2d7df857c..81b9ac617 100644 --- a/build/docs/WebChatMemberInfo.md +++ b/build/docs/WebChatMemberInfo.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatMemberInfoEntityList.md b/build/docs/WebChatMemberInfoEntityList.md index bd679bac1..f9c5b040c 100644 --- a/build/docs/WebChatMemberInfoEntityList.md +++ b/build/docs/WebChatMemberInfoEntityList.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatMessage.md b/build/docs/WebChatMessage.md index 47c9326f3..ab35bd282 100644 --- a/build/docs/WebChatMessage.md +++ b/build/docs/WebChatMessage.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatMessageEntityList.md b/build/docs/WebChatMessageEntityList.md index 7456d0d78..aace4ada2 100644 --- a/build/docs/WebChatMessageEntityList.md +++ b/build/docs/WebChatMessageEntityList.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatRoutingTarget.md b/build/docs/WebChatRoutingTarget.md index 96984166c..90301599a 100644 --- a/build/docs/WebChatRoutingTarget.md +++ b/build/docs/WebChatRoutingTarget.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatSettings.md b/build/docs/WebChatSettings.md index c318f1c58..1af17a5f5 100644 --- a/build/docs/WebChatSettings.md +++ b/build/docs/WebChatSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebChatTyping.md b/build/docs/WebChatTyping.md index d7d226041..9857cc2a8 100644 --- a/build/docs/WebChatTyping.md +++ b/build/docs/WebChatTyping.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeployment.md b/build/docs/WebDeployment.md index f06d8230c..74f01d6e9 100644 --- a/build/docs/WebDeployment.md +++ b/build/docs/WebDeployment.md @@ -24,4 +24,4 @@ Details about a Web Deployment -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentActiveConfigurationOnDeployment.md b/build/docs/WebDeploymentActiveConfigurationOnDeployment.md index 4028f9e7a..e0f27cecc 100644 --- a/build/docs/WebDeploymentActiveConfigurationOnDeployment.md +++ b/build/docs/WebDeploymentActiveConfigurationOnDeployment.md @@ -12,4 +12,4 @@ Details about the active configuration on a deployment -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentConfigurationVersion.md b/build/docs/WebDeploymentConfigurationVersion.md index cd054ca7e..932ffe235 100644 --- a/build/docs/WebDeploymentConfigurationVersion.md +++ b/build/docs/WebDeploymentConfigurationVersion.md @@ -32,4 +32,4 @@ Details about the configuration version of a Web Deployment -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentConfigurationVersionEntityListing.md b/build/docs/WebDeploymentConfigurationVersionEntityListing.md index 22ef39ba0..216682070 100644 --- a/build/docs/WebDeploymentConfigurationVersionEntityListing.md +++ b/build/docs/WebDeploymentConfigurationVersionEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentConfigurationVersionEntityRef.md b/build/docs/WebDeploymentConfigurationVersionEntityRef.md index 576038704..34382d984 100644 --- a/build/docs/WebDeploymentConfigurationVersionEntityRef.md +++ b/build/docs/WebDeploymentConfigurationVersionEntityRef.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentConfigurationVersionResponse.md b/build/docs/WebDeploymentConfigurationVersionResponse.md index 50bacb4b8..c01be69c8 100644 --- a/build/docs/WebDeploymentConfigurationVersionResponse.md +++ b/build/docs/WebDeploymentConfigurationVersionResponse.md @@ -32,4 +32,4 @@ Details about the configuration version of a Web Deployment -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentFlowEntityRef.md b/build/docs/WebDeploymentFlowEntityRef.md index d12693299..c250eb113 100644 --- a/build/docs/WebDeploymentFlowEntityRef.md +++ b/build/docs/WebDeploymentFlowEntityRef.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentHeadlessMode.md b/build/docs/WebDeploymentHeadlessMode.md index bb7f44b4f..ad2510efb 100644 --- a/build/docs/WebDeploymentHeadlessMode.md +++ b/build/docs/WebDeploymentHeadlessMode.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsAPI.md b/build/docs/WebDeploymentsAPI.md index c3c2df319..c76b45d8d 100644 --- a/build/docs/WebDeploymentsAPI.md +++ b/build/docs/WebDeploymentsAPI.md @@ -988,4 +988,4 @@ WebDeploymentsAPI.putWebdeploymentsDeployment(deploymentId: deploymentId, deploy [**WebDeployment**](WebDeployment) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsAuthorizationResponse.md b/build/docs/WebDeploymentsAuthorizationResponse.md index d8812f971..eca87ed6a 100644 --- a/build/docs/WebDeploymentsAuthorizationResponse.md +++ b/build/docs/WebDeploymentsAuthorizationResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsConfigTopicWebMessagingConfigChangeEventBody.md b/build/docs/WebDeploymentsConfigTopicWebMessagingConfigChangeEventBody.md index 1388f3a9f..77472d904 100644 --- a/build/docs/WebDeploymentsConfigTopicWebMessagingConfigChangeEventBody.md +++ b/build/docs/WebDeploymentsConfigTopicWebMessagingConfigChangeEventBody.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody.md b/build/docs/WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody.md index 0696fd922..adf9f2167 100644 --- a/build/docs/WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody.md +++ b/build/docs/WebDeploymentsDeploymentTopicWebMessagingConfigChangeEventBody.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsDeploymentTopicWebMessagingDeploymentChangeEventBody.md b/build/docs/WebDeploymentsDeploymentTopicWebMessagingDeploymentChangeEventBody.md index 81daf847b..0ab23d4aa 100644 --- a/build/docs/WebDeploymentsDeploymentTopicWebMessagingDeploymentChangeEventBody.md +++ b/build/docs/WebDeploymentsDeploymentTopicWebMessagingDeploymentChangeEventBody.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsJourneyContext.md b/build/docs/WebDeploymentsJourneyContext.md index 9a28693bf..09372f948 100644 --- a/build/docs/WebDeploymentsJourneyContext.md +++ b/build/docs/WebDeploymentsJourneyContext.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsOAuthExchangeRequest.md b/build/docs/WebDeploymentsOAuthExchangeRequest.md index e2dffb663..561fd97b5 100644 --- a/build/docs/WebDeploymentsOAuthExchangeRequest.md +++ b/build/docs/WebDeploymentsOAuthExchangeRequest.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsOAuthRequestParameters.md b/build/docs/WebDeploymentsOAuthRequestParameters.md index fb0d48eeb..da02d9de7 100644 --- a/build/docs/WebDeploymentsOAuthRequestParameters.md +++ b/build/docs/WebDeploymentsOAuthRequestParameters.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebDeploymentsRefreshJWTRequest.md b/build/docs/WebDeploymentsRefreshJWTRequest.md index b85035833..f7961c637 100644 --- a/build/docs/WebDeploymentsRefreshJWTRequest.md +++ b/build/docs/WebDeploymentsRefreshJWTRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebEvent.md b/build/docs/WebEvent.md index 42aaed198..fff1d3348 100644 --- a/build/docs/WebEvent.md +++ b/build/docs/WebEvent.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebEventBrowser.md b/build/docs/WebEventBrowser.md index bd3744f35..9b120e375 100644 --- a/build/docs/WebEventBrowser.md +++ b/build/docs/WebEventBrowser.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebEventDevice.md b/build/docs/WebEventDevice.md index 354bcb809..4614f3de6 100644 --- a/build/docs/WebEventDevice.md +++ b/build/docs/WebEventDevice.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebEventRequest.md b/build/docs/WebEventRequest.md index 38474ddcd..ea05c096c 100644 --- a/build/docs/WebEventRequest.md +++ b/build/docs/WebEventRequest.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebEventResponse.md b/build/docs/WebEventResponse.md index ec45d0cc1..eea65b6b0 100644 --- a/build/docs/WebEventResponse.md +++ b/build/docs/WebEventResponse.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebEventResponseSession.md b/build/docs/WebEventResponseSession.md index c57eb0e8b..23f11cc4e 100644 --- a/build/docs/WebEventResponseSession.md +++ b/build/docs/WebEventResponseSession.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingAPI.md b/build/docs/WebMessagingAPI.md index ef4e748d3..780877e39 100644 --- a/build/docs/WebMessagingAPI.md +++ b/build/docs/WebMessagingAPI.md @@ -59,4 +59,4 @@ WebMessagingAPI.getWebmessagingMessages(pageSize: pageSize, pageNumber: pageNumb [**WebMessagingMessageEntityList**](WebMessagingMessageEntityList) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingAttachment.md b/build/docs/WebMessagingAttachment.md index b5bcc9628..76b364dd8 100644 --- a/build/docs/WebMessagingAttachment.md +++ b/build/docs/WebMessagingAttachment.md @@ -18,4 +18,4 @@ Attachment object. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingButtonResponse.md b/build/docs/WebMessagingButtonResponse.md index 55ef36a9e..45edf6889 100644 --- a/build/docs/WebMessagingButtonResponse.md +++ b/build/docs/WebMessagingButtonResponse.md @@ -14,4 +14,4 @@ Button response object representing the click of a structured message button, su -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingChannel.md b/build/docs/WebMessagingChannel.md index 193de4050..e735cdc8b 100644 --- a/build/docs/WebMessagingChannel.md +++ b/build/docs/WebMessagingChannel.md @@ -14,4 +14,4 @@ Channel-specific information that describes the message and the message channel/ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingContent.md b/build/docs/WebMessagingContent.md index a9d909bf2..7c288152c 100644 --- a/build/docs/WebMessagingContent.md +++ b/build/docs/WebMessagingContent.md @@ -17,4 +17,4 @@ Message content element. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingEvent.md b/build/docs/WebMessagingEvent.md index 012201845..c3b2a4c76 100644 --- a/build/docs/WebMessagingEvent.md +++ b/build/docs/WebMessagingEvent.md @@ -13,4 +13,4 @@ Message event element. Examples include: system messages, typing indicators, co -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingEventCoBrowse.md b/build/docs/WebMessagingEventCoBrowse.md index 23f63860f..277d0cdc2 100644 --- a/build/docs/WebMessagingEventCoBrowse.md +++ b/build/docs/WebMessagingEventCoBrowse.md @@ -13,4 +13,4 @@ A Cobrowse event. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingEventPresence.md b/build/docs/WebMessagingEventPresence.md index 3905b5cc7..5939cd3c4 100644 --- a/build/docs/WebMessagingEventPresence.md +++ b/build/docs/WebMessagingEventPresence.md @@ -11,4 +11,4 @@ A Presence event. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingGeneric.md b/build/docs/WebMessagingGeneric.md index 8372b89cb..69be0f416 100644 --- a/build/docs/WebMessagingGeneric.md +++ b/build/docs/WebMessagingGeneric.md @@ -15,4 +15,4 @@ Generic content object. (Deprecated -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingMessage.md b/build/docs/WebMessagingMessage.md index 5a9152673..0ee220167 100644 --- a/build/docs/WebMessagingMessage.md +++ b/build/docs/WebMessagingMessage.md @@ -19,4 +19,4 @@ A web messaging message -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingMessageEntityList.md b/build/docs/WebMessagingMessageEntityList.md index 0b7d6631d..a5f0280a4 100644 --- a/build/docs/WebMessagingMessageEntityList.md +++ b/build/docs/WebMessagingMessageEntityList.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingOfferFields.md b/build/docs/WebMessagingOfferFields.md index fc9b2a834..ff2feccee 100644 --- a/build/docs/WebMessagingOfferFields.md +++ b/build/docs/WebMessagingOfferFields.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingOfferProperties.md b/build/docs/WebMessagingOfferProperties.md index 94639fd11..f42567039 100644 --- a/build/docs/WebMessagingOfferProperties.md +++ b/build/docs/WebMessagingOfferProperties.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingQuickReply.md b/build/docs/WebMessagingQuickReply.md index 5a27ef0b8..038f32bc5 100644 --- a/build/docs/WebMessagingQuickReply.md +++ b/build/docs/WebMessagingQuickReply.md @@ -14,4 +14,4 @@ Quick reply object -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WebMessagingRecipient.md b/build/docs/WebMessagingRecipient.md index f9af16056..384af775c 100644 --- a/build/docs/WebMessagingRecipient.md +++ b/build/docs/WebMessagingRecipient.md @@ -15,4 +15,4 @@ Information about the recipient the message is sent to or received from. -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekSchedule.md b/build/docs/WeekSchedule.md index 40d668c83..0e821fbb5 100644 --- a/build/docs/WeekSchedule.md +++ b/build/docs/WeekSchedule.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekScheduleGenerationResult.md b/build/docs/WeekScheduleGenerationResult.md index 4a276831c..f8078b4c2 100644 --- a/build/docs/WeekScheduleGenerationResult.md +++ b/build/docs/WeekScheduleGenerationResult.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekScheduleListItemResponse.md b/build/docs/WeekScheduleListItemResponse.md index 694623cd4..ae970c845 100644 --- a/build/docs/WeekScheduleListItemResponse.md +++ b/build/docs/WeekScheduleListItemResponse.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekScheduleListResponse.md b/build/docs/WeekScheduleListResponse.md index d9f5da51a..101acd995 100644 --- a/build/docs/WeekScheduleListResponse.md +++ b/build/docs/WeekScheduleListResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekScheduleReference.md b/build/docs/WeekScheduleReference.md index fd5542e01..4d7aa1348 100644 --- a/build/docs/WeekScheduleReference.md +++ b/build/docs/WeekScheduleReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekScheduleResponse.md b/build/docs/WeekScheduleResponse.md index d0cb86a3f..748f5d666 100644 --- a/build/docs/WeekScheduleResponse.md +++ b/build/docs/WeekScheduleResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekShiftTradeListResponse.md b/build/docs/WeekShiftTradeListResponse.md index f30681b13..c615bf594 100644 --- a/build/docs/WeekShiftTradeListResponse.md +++ b/build/docs/WeekShiftTradeListResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekShiftTradeMatchesSummaryResponse.md b/build/docs/WeekShiftTradeMatchesSummaryResponse.md index f2e221c9b..fff185891 100644 --- a/build/docs/WeekShiftTradeMatchesSummaryResponse.md +++ b/build/docs/WeekShiftTradeMatchesSummaryResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WeekShiftTradeResponse.md b/build/docs/WeekShiftTradeResponse.md index d095892ec..042d98a4d 100644 --- a/build/docs/WeekShiftTradeResponse.md +++ b/build/docs/WeekShiftTradeResponse.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WemCoachingUserNotificationTopicCoachingAppointmentReference.md b/build/docs/WemCoachingUserNotificationTopicCoachingAppointmentReference.md index 86b59833b..856e17a6d 100644 --- a/build/docs/WemCoachingUserNotificationTopicCoachingAppointmentReference.md +++ b/build/docs/WemCoachingUserNotificationTopicCoachingAppointmentReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WemCoachingUserNotificationTopicCoachingUserNotification.md b/build/docs/WemCoachingUserNotificationTopicCoachingUserNotification.md index f0514c0f7..c147bc75c 100644 --- a/build/docs/WemCoachingUserNotificationTopicCoachingUserNotification.md +++ b/build/docs/WemCoachingUserNotificationTopicCoachingUserNotification.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanJobException.md b/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanJobException.md index c2804d18e..c39aeca65 100644 --- a/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanJobException.md +++ b/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanJobException.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceDeletionJobCompleteNotification.md b/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceDeletionJobCompleteNotification.md index 0b1e2e658..c59114236 100644 --- a/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceDeletionJobCompleteNotification.md +++ b/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceDeletionJobCompleteNotification.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceReference.md b/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceReference.md index 11c1d3570..b377b7ce2 100644 --- a/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceReference.md +++ b/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanOccurrenceReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanReference.md b/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanReference.md index 772042534..09d4a559b 100644 --- a/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanReference.md +++ b/build/docs/WfmActivityPlanJobCompleteTopicActivityPlanReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanJobCompleteTopicErrorBody.md b/build/docs/WfmActivityPlanJobCompleteTopicErrorBody.md index d298da5b9..a20be246d 100644 --- a/build/docs/WfmActivityPlanJobCompleteTopicErrorBody.md +++ b/build/docs/WfmActivityPlanJobCompleteTopicErrorBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanJobException.md b/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanJobException.md index 272303f2d..6f8e0d830 100644 --- a/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanJobException.md +++ b/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanJobException.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanOccurrenceReference.md b/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanOccurrenceReference.md index 6b3822cdb..4fd57e409 100644 --- a/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanOccurrenceReference.md +++ b/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanOccurrenceReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanReference.md b/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanReference.md index 4e4ae5913..4a771ac2b 100644 --- a/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanReference.md +++ b/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanRunJobCompleteNotification.md b/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanRunJobCompleteNotification.md index 3f7b1807b..4fa3ddfbf 100644 --- a/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanRunJobCompleteNotification.md +++ b/build/docs/WfmActivityPlanRunJobCompleteTopicActivityPlanRunJobCompleteNotification.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmActivityPlanRunJobCompleteTopicErrorBody.md b/build/docs/WfmActivityPlanRunJobCompleteTopicErrorBody.md index 71a156871..b416efd02 100644 --- a/build/docs/WfmActivityPlanRunJobCompleteTopicErrorBody.md +++ b/build/docs/WfmActivityPlanRunJobCompleteTopicErrorBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationChangedNotification.md b/build/docs/WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationChangedNotification.md index cabafa6ec..10c3ae9a8 100644 --- a/build/docs/WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationChangedNotification.md +++ b/build/docs/WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationChangedNotification.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationJobNotification.md b/build/docs/WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationJobNotification.md index 92caa8270..b27d9f898 100644 --- a/build/docs/WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationJobNotification.md +++ b/build/docs/WfmAdherenceExplanationJobCompleteTopicAdherenceExplanationJobNotification.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAdherenceExplanationJobCompleteTopicBusinessUnit.md b/build/docs/WfmAdherenceExplanationJobCompleteTopicBusinessUnit.md index 112d47806..265450ceb 100644 --- a/build/docs/WfmAdherenceExplanationJobCompleteTopicBusinessUnit.md +++ b/build/docs/WfmAdherenceExplanationJobCompleteTopicBusinessUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAdherenceExplanationJobCompleteTopicErrorBody.md b/build/docs/WfmAdherenceExplanationJobCompleteTopicErrorBody.md index b79addcaa..34a8c5bfb 100644 --- a/build/docs/WfmAdherenceExplanationJobCompleteTopicErrorBody.md +++ b/build/docs/WfmAdherenceExplanationJobCompleteTopicErrorBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAdherenceExplanationJobCompleteTopicManagementUnit.md b/build/docs/WfmAdherenceExplanationJobCompleteTopicManagementUnit.md index ec8031a86..71b44ccf6 100644 --- a/build/docs/WfmAdherenceExplanationJobCompleteTopicManagementUnit.md +++ b/build/docs/WfmAdherenceExplanationJobCompleteTopicManagementUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAdherenceExplanationJobCompleteTopicUserReference.md b/build/docs/WfmAdherenceExplanationJobCompleteTopicUserReference.md index 198001f82..d41b4c828 100644 --- a/build/docs/WfmAdherenceExplanationJobCompleteTopicUserReference.md +++ b/build/docs/WfmAdherenceExplanationJobCompleteTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgent.md b/build/docs/WfmAgent.md index b80533610..e7d50b746 100644 --- a/build/docs/WfmAgent.md +++ b/build/docs/WfmAgent.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicAdherenceExplanationChangedNotification.md b/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicAdherenceExplanationChangedNotification.md index 6366d9a25..85646ee60 100644 --- a/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicAdherenceExplanationChangedNotification.md +++ b/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicAdherenceExplanationChangedNotification.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicBusinessUnit.md b/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicBusinessUnit.md index af1dc23b8..a21bbe4d8 100644 --- a/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicBusinessUnit.md +++ b/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicBusinessUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicManagementUnit.md b/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicManagementUnit.md index 6f0941f4b..58a270a75 100644 --- a/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicManagementUnit.md +++ b/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicManagementUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicUserReference.md b/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicUserReference.md index d3bf74e20..296882b0f 100644 --- a/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicUserReference.md +++ b/build/docs/WfmAgentAdherenceExplanationChangedAgentTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicAdherenceExplanationChangedNotification.md b/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicAdherenceExplanationChangedNotification.md index 999f654e4..250566429 100644 --- a/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicAdherenceExplanationChangedNotification.md +++ b/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicAdherenceExplanationChangedNotification.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicBusinessUnit.md b/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicBusinessUnit.md index ca85c70d5..015a63b96 100644 --- a/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicBusinessUnit.md +++ b/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicBusinessUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicManagementUnit.md b/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicManagementUnit.md index 6a47ca016..729938ebd 100644 --- a/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicManagementUnit.md +++ b/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicManagementUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicUserReference.md b/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicUserReference.md index 461403080..af898e3b0 100644 --- a/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicUserReference.md +++ b/build/docs/WfmAgentAdherenceExplanationChangedBusinessUnitTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentScheduleUpdateTopicAgentScheduleShiftUpdate.md b/build/docs/WfmAgentScheduleUpdateTopicAgentScheduleShiftUpdate.md index 64e753419..eaadc0777 100644 --- a/build/docs/WfmAgentScheduleUpdateTopicAgentScheduleShiftUpdate.md +++ b/build/docs/WfmAgentScheduleUpdateTopicAgentScheduleShiftUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentScheduleUpdateTopicAgentScheduleUpdateNotification.md b/build/docs/WfmAgentScheduleUpdateTopicAgentScheduleUpdateNotification.md index 0b9a8d14b..e400ee626 100644 --- a/build/docs/WfmAgentScheduleUpdateTopicAgentScheduleUpdateNotification.md +++ b/build/docs/WfmAgentScheduleUpdateTopicAgentScheduleUpdateNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAgentScheduleUpdateTopicUserReference.md b/build/docs/WfmAgentScheduleUpdateTopicUserReference.md index b1c4ff04c..0b7286bda 100644 --- a/build/docs/WfmAgentScheduleUpdateTopicUserReference.md +++ b/build/docs/WfmAgentScheduleUpdateTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAlternativeShiftJobCompleteEventV3AlternativeShiftJobCompleteNotification.md b/build/docs/WfmAlternativeShiftJobCompleteEventV3AlternativeShiftJobCompleteNotification.md index 11802d245..efc59d0fb 100644 --- a/build/docs/WfmAlternativeShiftJobCompleteEventV3AlternativeShiftJobCompleteNotification.md +++ b/build/docs/WfmAlternativeShiftJobCompleteEventV3AlternativeShiftJobCompleteNotification.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmAlternativeShiftJobCompleteEventV3ErrorBody.md b/build/docs/WfmAlternativeShiftJobCompleteEventV3ErrorBody.md index 85e7574b9..568a67156 100644 --- a/build/docs/WfmAlternativeShiftJobCompleteEventV3ErrorBody.md +++ b/build/docs/WfmAlternativeShiftJobCompleteEventV3ErrorBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayDataGroup.md b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayDataGroup.md index e30571487..2a1bc038e 100644 --- a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayDataGroup.md +++ b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayDataGroup.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayForecastData.md b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayForecastData.md index 723e56c51..9667f9429 100644 --- a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayForecastData.md +++ b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayForecastData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayNotification.md b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayNotification.md index 3c201f28f..088938808 100644 --- a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayNotification.md +++ b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayResult.md b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayResult.md index f3e49f8da..f26c3efdb 100644 --- a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayResult.md +++ b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayResult.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayScheduleData.md b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayScheduleData.md index ce0a6b152..dbeec493e 100644 --- a/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayScheduleData.md +++ b/build/docs/WfmBuIntradayDataUpdateTopicBuIntradayScheduleData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuIntradayDataUpdateTopicBuScheduleReference.md b/build/docs/WfmBuIntradayDataUpdateTopicBuScheduleReference.md index ecd70e796..171d1ca9c 100644 --- a/build/docs/WfmBuIntradayDataUpdateTopicBuScheduleReference.md +++ b/build/docs/WfmBuIntradayDataUpdateTopicBuScheduleReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuIntradayDataUpdateTopicBuShortTermForecastReference.md b/build/docs/WfmBuIntradayDataUpdateTopicBuShortTermForecastReference.md index 66aa3486d..be2d0ce71 100644 --- a/build/docs/WfmBuIntradayDataUpdateTopicBuShortTermForecastReference.md +++ b/build/docs/WfmBuIntradayDataUpdateTopicBuShortTermForecastReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuIntradayDataUpdateTopicIntradayPerformancePredictionData.md b/build/docs/WfmBuIntradayDataUpdateTopicIntradayPerformancePredictionData.md index 87d6b1568..ae0f21a82 100644 --- a/build/docs/WfmBuIntradayDataUpdateTopicIntradayPerformancePredictionData.md +++ b/build/docs/WfmBuIntradayDataUpdateTopicIntradayPerformancePredictionData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleQueryResultTopicBuScheduleSearchResultNotification.md b/build/docs/WfmBuScheduleQueryResultTopicBuScheduleSearchResultNotification.md index 8691405c3..68209a568 100644 --- a/build/docs/WfmBuScheduleQueryResultTopicBuScheduleSearchResultNotification.md +++ b/build/docs/WfmBuScheduleQueryResultTopicBuScheduleSearchResultNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleRunTopicBuScheduleReference.md b/build/docs/WfmBuScheduleRunTopicBuScheduleReference.md index 4402d869b..b26a1b8ff 100644 --- a/build/docs/WfmBuScheduleRunTopicBuScheduleReference.md +++ b/build/docs/WfmBuScheduleRunTopicBuScheduleReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleRunTopicBuScheduleRun.md b/build/docs/WfmBuScheduleRunTopicBuScheduleRun.md index ffd81f26e..d1c317344 100644 --- a/build/docs/WfmBuScheduleRunTopicBuScheduleRun.md +++ b/build/docs/WfmBuScheduleRunTopicBuScheduleRun.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleRunTopicBuSchedulingRunProgressNotification.md b/build/docs/WfmBuScheduleRunTopicBuSchedulingRunProgressNotification.md index a7ccc5a45..bd646b5e6 100644 --- a/build/docs/WfmBuScheduleRunTopicBuSchedulingRunProgressNotification.md +++ b/build/docs/WfmBuScheduleRunTopicBuSchedulingRunProgressNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleRunTopicSchedulerMessageSeverityCount.md b/build/docs/WfmBuScheduleRunTopicSchedulerMessageSeverityCount.md index 1e0a70db5..ae2a7648d 100644 --- a/build/docs/WfmBuScheduleRunTopicSchedulerMessageSeverityCount.md +++ b/build/docs/WfmBuScheduleRunTopicSchedulerMessageSeverityCount.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleRunTopicUserReference.md b/build/docs/WfmBuScheduleRunTopicUserReference.md index 66bd99bea..5841dce0c 100644 --- a/build/docs/WfmBuScheduleRunTopicUserReference.md +++ b/build/docs/WfmBuScheduleRunTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleSearchResultTopicBuScheduleSearchResultNotification.md b/build/docs/WfmBuScheduleSearchResultTopicBuScheduleSearchResultNotification.md index 84a16342c..63c363ad7 100644 --- a/build/docs/WfmBuScheduleSearchResultTopicBuScheduleSearchResultNotification.md +++ b/build/docs/WfmBuScheduleSearchResultTopicBuScheduleSearchResultNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicBuManagementUnitScheduleSummary.md b/build/docs/WfmBuScheduleTopicBuManagementUnitScheduleSummary.md index 0640fa8f1..d677a97f8 100644 --- a/build/docs/WfmBuScheduleTopicBuManagementUnitScheduleSummary.md +++ b/build/docs/WfmBuScheduleTopicBuManagementUnitScheduleSummary.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicBuScheduleGenerationResultSummary.md b/build/docs/WfmBuScheduleTopicBuScheduleGenerationResultSummary.md index 3e1d0eb89..bf4a2186e 100644 --- a/build/docs/WfmBuScheduleTopicBuScheduleGenerationResultSummary.md +++ b/build/docs/WfmBuScheduleTopicBuScheduleGenerationResultSummary.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicBuScheduleMetadata.md b/build/docs/WfmBuScheduleTopicBuScheduleMetadata.md index 3badca356..8a4ed2bf6 100644 --- a/build/docs/WfmBuScheduleTopicBuScheduleMetadata.md +++ b/build/docs/WfmBuScheduleTopicBuScheduleMetadata.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicBuScheduleNotification.md b/build/docs/WfmBuScheduleTopicBuScheduleNotification.md index 333a6d6ff..47068e029 100644 --- a/build/docs/WfmBuScheduleTopicBuScheduleNotification.md +++ b/build/docs/WfmBuScheduleTopicBuScheduleNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicBuShortTermForecastReference.md b/build/docs/WfmBuScheduleTopicBuShortTermForecastReference.md index f6f921b2f..b9abb632b 100644 --- a/build/docs/WfmBuScheduleTopicBuShortTermForecastReference.md +++ b/build/docs/WfmBuScheduleTopicBuShortTermForecastReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicManagementUnit.md b/build/docs/WfmBuScheduleTopicManagementUnit.md index ef60ad56b..960682494 100644 --- a/build/docs/WfmBuScheduleTopicManagementUnit.md +++ b/build/docs/WfmBuScheduleTopicManagementUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicSchedulerMessageSeverityCount.md b/build/docs/WfmBuScheduleTopicSchedulerMessageSeverityCount.md index 9664ad2c4..6ebbd8f2c 100644 --- a/build/docs/WfmBuScheduleTopicSchedulerMessageSeverityCount.md +++ b/build/docs/WfmBuScheduleTopicSchedulerMessageSeverityCount.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicUserReference.md b/build/docs/WfmBuScheduleTopicUserReference.md index f60dac202..50e7fe763 100644 --- a/build/docs/WfmBuScheduleTopicUserReference.md +++ b/build/docs/WfmBuScheduleTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuScheduleTopicWfmVersionedEntityMetadata.md b/build/docs/WfmBuScheduleTopicWfmVersionedEntityMetadata.md index 1e7ffb388..47fbcae99 100644 --- a/build/docs/WfmBuScheduleTopicWfmVersionedEntityMetadata.md +++ b/build/docs/WfmBuScheduleTopicWfmVersionedEntityMetadata.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuForecastModification.md b/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuForecastModification.md index 5fbc32937..fd6b06791 100644 --- a/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuForecastModification.md +++ b/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuForecastModification.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecast.md b/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecast.md index 58c5b5c26..f243e75d1 100644 --- a/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecast.md +++ b/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecast.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecastNotification.md b/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecastNotification.md index 8d0e9b384..9fc84c649 100644 --- a/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecastNotification.md +++ b/build/docs/WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecastNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastCopyCompleteTopicForecastSourceDayPointer.md b/build/docs/WfmBuShortTermForecastCopyCompleteTopicForecastSourceDayPointer.md index f8f98f3d7..901f98af4 100644 --- a/build/docs/WfmBuShortTermForecastCopyCompleteTopicForecastSourceDayPointer.md +++ b/build/docs/WfmBuShortTermForecastCopyCompleteTopicForecastSourceDayPointer.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastCopyCompleteTopicModificationIntervalOffsetValue.md b/build/docs/WfmBuShortTermForecastCopyCompleteTopicModificationIntervalOffsetValue.md index b7b98678c..224bfe1bc 100644 --- a/build/docs/WfmBuShortTermForecastCopyCompleteTopicModificationIntervalOffsetValue.md +++ b/build/docs/WfmBuShortTermForecastCopyCompleteTopicModificationIntervalOffsetValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastCopyCompleteTopicUserReference.md b/build/docs/WfmBuShortTermForecastCopyCompleteTopicUserReference.md index f4b5a3192..db1129826 100644 --- a/build/docs/WfmBuShortTermForecastCopyCompleteTopicUserReference.md +++ b/build/docs/WfmBuShortTermForecastCopyCompleteTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastCopyCompleteTopicWfmVersionedEntityMetadata.md b/build/docs/WfmBuShortTermForecastCopyCompleteTopicWfmVersionedEntityMetadata.md index 1a5b40dea..ad9a1c897 100644 --- a/build/docs/WfmBuShortTermForecastCopyCompleteTopicWfmVersionedEntityMetadata.md +++ b/build/docs/WfmBuShortTermForecastCopyCompleteTopicWfmVersionedEntityMetadata.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastGenerateProgressTopicBuForecastModification.md b/build/docs/WfmBuShortTermForecastGenerateProgressTopicBuForecastModification.md index 42fa5cbd9..fc1aa8e70 100644 --- a/build/docs/WfmBuShortTermForecastGenerateProgressTopicBuForecastModification.md +++ b/build/docs/WfmBuShortTermForecastGenerateProgressTopicBuForecastModification.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastGenerateProgressTopicBuShortTermForecast.md b/build/docs/WfmBuShortTermForecastGenerateProgressTopicBuShortTermForecast.md index 82699d535..d62ed3cf2 100644 --- a/build/docs/WfmBuShortTermForecastGenerateProgressTopicBuShortTermForecast.md +++ b/build/docs/WfmBuShortTermForecastGenerateProgressTopicBuShortTermForecast.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastGenerateProgressTopicForecastSourceDayPointer.md b/build/docs/WfmBuShortTermForecastGenerateProgressTopicForecastSourceDayPointer.md index 1ba01ce91..38f3b8df9 100644 --- a/build/docs/WfmBuShortTermForecastGenerateProgressTopicForecastSourceDayPointer.md +++ b/build/docs/WfmBuShortTermForecastGenerateProgressTopicForecastSourceDayPointer.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastGenerateProgressTopicGenerateBuShortTermForecastProgressNotification.md b/build/docs/WfmBuShortTermForecastGenerateProgressTopicGenerateBuShortTermForecastProgressNotification.md index 10b18fc26..e049e79f8 100644 --- a/build/docs/WfmBuShortTermForecastGenerateProgressTopicGenerateBuShortTermForecastProgressNotification.md +++ b/build/docs/WfmBuShortTermForecastGenerateProgressTopicGenerateBuShortTermForecastProgressNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastGenerateProgressTopicModificationIntervalOffsetValue.md b/build/docs/WfmBuShortTermForecastGenerateProgressTopicModificationIntervalOffsetValue.md index 305beab4c..c4cb40047 100644 --- a/build/docs/WfmBuShortTermForecastGenerateProgressTopicModificationIntervalOffsetValue.md +++ b/build/docs/WfmBuShortTermForecastGenerateProgressTopicModificationIntervalOffsetValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastGenerateProgressTopicUserReference.md b/build/docs/WfmBuShortTermForecastGenerateProgressTopicUserReference.md index 09245722f..cb309b83c 100644 --- a/build/docs/WfmBuShortTermForecastGenerateProgressTopicUserReference.md +++ b/build/docs/WfmBuShortTermForecastGenerateProgressTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastGenerateProgressTopicWfmVersionedEntityMetadata.md b/build/docs/WfmBuShortTermForecastGenerateProgressTopicWfmVersionedEntityMetadata.md index 6956223c2..fb27185d8 100644 --- a/build/docs/WfmBuShortTermForecastGenerateProgressTopicWfmVersionedEntityMetadata.md +++ b/build/docs/WfmBuShortTermForecastGenerateProgressTopicWfmVersionedEntityMetadata.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md b/build/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md index f2dc94577..48a8ec4eb 100644 --- a/build/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md +++ b/build/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md b/build/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md index 2b74a86f3..ab51ee4d4 100644 --- a/build/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md +++ b/build/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecast.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md b/build/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md index b94779fea..aaec66147 100644 --- a/build/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md +++ b/build/docs/WfmBuShortTermForecastImportCompleteTopicBuShortTermForecastNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md b/build/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md index 3a159bbc5..1c333dfdb 100644 --- a/build/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md +++ b/build/docs/WfmBuShortTermForecastImportCompleteTopicForecastSourceDayPointer.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md b/build/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md index 094766ae1..f164dcd07 100644 --- a/build/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md +++ b/build/docs/WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md b/build/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md index e70be0784..12ea44c58 100644 --- a/build/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md +++ b/build/docs/WfmBuShortTermForecastImportCompleteTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md b/build/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md index abe732ff1..14bc3ee90 100644 --- a/build/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md +++ b/build/docs/WfmBuShortTermForecastImportCompleteTopicWfmVersionedEntityMetadata.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuForecastShortTermStaffingRequirementsNotification.md b/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuForecastShortTermStaffingRequirementsNotification.md index 9428a7aa8..0a030a58e 100644 --- a/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuForecastShortTermStaffingRequirementsNotification.md +++ b/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuForecastShortTermStaffingRequirementsNotification.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuForecastShortTermStaffingRequirementsResults.md b/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuForecastShortTermStaffingRequirementsResults.md index eb4580083..ff11fb2d4 100644 --- a/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuForecastShortTermStaffingRequirementsResults.md +++ b/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuForecastShortTermStaffingRequirementsResults.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuShortTermForecastReference.md b/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuShortTermForecastReference.md index 501125cab..16da17b54 100644 --- a/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuShortTermForecastReference.md +++ b/build/docs/WfmBuShortTermForecastStaffingRequirementsGenerateCompleteTopicBuShortTermForecastReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification.md b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification.md index 8869fcedf..3da01dfaf 100644 --- a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification.md +++ b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuForecastModification.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecast.md b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecast.md index d1b22db14..c0ee286b5 100644 --- a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecast.md +++ b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecast.md @@ -22,4 +22,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecastNotification.md b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecastNotification.md index 035603c3c..133f2252d 100644 --- a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecastNotification.md +++ b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicBuShortTermForecastNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicForecastSourceDayPointer.md b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicForecastSourceDayPointer.md index 4ddd402ec..affff4db1 100644 --- a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicForecastSourceDayPointer.md +++ b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicForecastSourceDayPointer.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicModificationIntervalOffsetValue.md b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicModificationIntervalOffsetValue.md index f590cf6d0..3309da9b4 100644 --- a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicModificationIntervalOffsetValue.md +++ b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicModificationIntervalOffsetValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicUserReference.md b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicUserReference.md index d60fd7ad8..88c32a089 100644 --- a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicUserReference.md +++ b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicWfmVersionedEntityMetadata.md b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicWfmVersionedEntityMetadata.md index c85ff4fb7..aa4265d3d 100644 --- a/build/docs/WfmBuShortTermForecastUpdateCompleteTopicWfmVersionedEntityMetadata.md +++ b/build/docs/WfmBuShortTermForecastUpdateCompleteTopicWfmVersionedEntityMetadata.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateNotification.md b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateNotification.md index cc0923b7a..b83ba1b4f 100644 --- a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateNotification.md +++ b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult.md b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult.md index a1e98522a..d17146ef6 100644 --- a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult.md +++ b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResult.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResultListing.md b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResultListing.md index 53db477b4..32247bc42 100644 --- a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResultListing.md +++ b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicBulkShiftTradeStateUpdateResultListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicUserReference.md b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicUserReference.md index 5e063e831..6732eeed6 100644 --- a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicUserReference.md +++ b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicWfmVersionedEntityMetadata.md b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicWfmVersionedEntityMetadata.md index 3f8a5ae43..8643605dd 100644 --- a/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicWfmVersionedEntityMetadata.md +++ b/build/docs/WfmBulkShiftTradeStateUpdateNotificationTopicWfmVersionedEntityMetadata.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmBusinessUnitReference.md b/build/docs/WfmBusinessUnitReference.md index 49e08ef73..9ee400943 100644 --- a/build/docs/WfmBusinessUnitReference.md +++ b/build/docs/WfmBusinessUnitReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmForecastModificationIntervalOffsetValue.md b/build/docs/WfmForecastModificationIntervalOffsetValue.md index 794636785..df9c2b43a 100644 --- a/build/docs/WfmForecastModificationIntervalOffsetValue.md +++ b/build/docs/WfmForecastModificationIntervalOffsetValue.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceBulkCalculationsCompleteTopicWfmHistoricalAdherenceBulkCalculationsCompleteNotification.md b/build/docs/WfmHistoricalAdherenceBulkCalculationsCompleteTopicWfmHistoricalAdherenceBulkCalculationsCompleteNotification.md index 57781fb3a..a7bac4d80 100644 --- a/build/docs/WfmHistoricalAdherenceBulkCalculationsCompleteTopicWfmHistoricalAdherenceBulkCalculationsCompleteNotification.md +++ b/build/docs/WfmHistoricalAdherenceBulkCalculationsCompleteTopicWfmHistoricalAdherenceBulkCalculationsCompleteNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceBulkItem.md b/build/docs/WfmHistoricalAdherenceBulkItem.md index fe12aac80..7b967e6a2 100644 --- a/build/docs/WfmHistoricalAdherenceBulkItem.md +++ b/build/docs/WfmHistoricalAdherenceBulkItem.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceBulkJobReference.md b/build/docs/WfmHistoricalAdherenceBulkJobReference.md index 6af20c0c4..abe3cf392 100644 --- a/build/docs/WfmHistoricalAdherenceBulkJobReference.md +++ b/build/docs/WfmHistoricalAdherenceBulkJobReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceBulkQuery.md b/build/docs/WfmHistoricalAdherenceBulkQuery.md index 8e66e75ce..f38f0a815 100644 --- a/build/docs/WfmHistoricalAdherenceBulkQuery.md +++ b/build/docs/WfmHistoricalAdherenceBulkQuery.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceBulkResponse.md b/build/docs/WfmHistoricalAdherenceBulkResponse.md index 88664f5fd..8607d916a 100644 --- a/build/docs/WfmHistoricalAdherenceBulkResponse.md +++ b/build/docs/WfmHistoricalAdherenceBulkResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceBulkResult.md b/build/docs/WfmHistoricalAdherenceBulkResult.md index 4474eebc2..b391b1d01 100644 --- a/build/docs/WfmHistoricalAdherenceBulkResult.md +++ b/build/docs/WfmHistoricalAdherenceBulkResult.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceBulkUserDayMetrics.md b/build/docs/WfmHistoricalAdherenceBulkUserDayMetrics.md index a964b03ef..413e1aa0b 100644 --- a/build/docs/WfmHistoricalAdherenceBulkUserDayMetrics.md +++ b/build/docs/WfmHistoricalAdherenceBulkUserDayMetrics.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceBulkUserResult.md b/build/docs/WfmHistoricalAdherenceBulkUserResult.md index f00fb0bef..c7731c944 100644 --- a/build/docs/WfmHistoricalAdherenceBulkUserResult.md +++ b/build/docs/WfmHistoricalAdherenceBulkUserResult.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceCalculationsCompleteTopicWfmHistoricalAdherenceCalculationsCompleteNotice.md b/build/docs/WfmHistoricalAdherenceCalculationsCompleteTopicWfmHistoricalAdherenceCalculationsCompleteNotice.md index eba165d6d..c235feeb1 100644 --- a/build/docs/WfmHistoricalAdherenceCalculationsCompleteTopicWfmHistoricalAdherenceCalculationsCompleteNotice.md +++ b/build/docs/WfmHistoricalAdherenceCalculationsCompleteTopicWfmHistoricalAdherenceCalculationsCompleteNotice.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceQuery.md b/build/docs/WfmHistoricalAdherenceQuery.md index fbb6f544d..0a1930314 100644 --- a/build/docs/WfmHistoricalAdherenceQuery.md +++ b/build/docs/WfmHistoricalAdherenceQuery.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceQueryForTeams.md b/build/docs/WfmHistoricalAdherenceQueryForTeams.md index 5418672e0..640e0a7c0 100644 --- a/build/docs/WfmHistoricalAdherenceQueryForTeams.md +++ b/build/docs/WfmHistoricalAdherenceQueryForTeams.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceQueryForUsers.md b/build/docs/WfmHistoricalAdherenceQueryForUsers.md index 05a65373d..6b47e533a 100644 --- a/build/docs/WfmHistoricalAdherenceQueryForUsers.md +++ b/build/docs/WfmHistoricalAdherenceQueryForUsers.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceResponse.md b/build/docs/WfmHistoricalAdherenceResponse.md index 13bb5fb58..ba44fc2a3 100644 --- a/build/docs/WfmHistoricalAdherenceResponse.md +++ b/build/docs/WfmHistoricalAdherenceResponse.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalAdherenceResultWrapper.md b/build/docs/WfmHistoricalAdherenceResultWrapper.md index 23883a45a..96403fb6e 100644 --- a/build/docs/WfmHistoricalAdherenceResultWrapper.md +++ b/build/docs/WfmHistoricalAdherenceResultWrapper.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md b/build/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md index 2fc4dc421..ab525383e 100644 --- a/build/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md +++ b/build/docs/WfmHistoricalDataUploadPurgeRequestStatusTopicHistoricalDataUploadPurgeRequestUpdate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md b/build/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md index 0b520461c..6e42cf2e3 100644 --- a/build/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md +++ b/build/docs/WfmHistoricalDataUploadRequestStatusTopicHistoricalDataUploadRequestUpdate.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalShrinkageCalculationsCompleteTopicHistoricalShrinkageCalculationsCompleteNotification.md b/build/docs/WfmHistoricalShrinkageCalculationsCompleteTopicHistoricalShrinkageCalculationsCompleteNotification.md index b7984fe00..360c22481 100644 --- a/build/docs/WfmHistoricalShrinkageCalculationsCompleteTopicHistoricalShrinkageCalculationsCompleteNotification.md +++ b/build/docs/WfmHistoricalShrinkageCalculationsCompleteTopicHistoricalShrinkageCalculationsCompleteNotification.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalShrinkageRequest.md b/build/docs/WfmHistoricalShrinkageRequest.md index d62afe3ed..471eacd2c 100644 --- a/build/docs/WfmHistoricalShrinkageRequest.md +++ b/build/docs/WfmHistoricalShrinkageRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalShrinkageResponse.md b/build/docs/WfmHistoricalShrinkageResponse.md index 3d65a254b..b86a511d4 100644 --- a/build/docs/WfmHistoricalShrinkageResponse.md +++ b/build/docs/WfmHistoricalShrinkageResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmHistoricalShrinkageTeamsRequest.md b/build/docs/WfmHistoricalShrinkageTeamsRequest.md index c7a4ce583..e4f79f971 100644 --- a/build/docs/WfmHistoricalShrinkageTeamsRequest.md +++ b/build/docs/WfmHistoricalShrinkageTeamsRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntegrationListing.md b/build/docs/WfmIntegrationListing.md index f6ba1ce1b..2a03dff0e 100644 --- a/build/docs/WfmIntegrationListing.md +++ b/build/docs/WfmIntegrationListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntegrationReference.md b/build/docs/WfmIntegrationReference.md index 3a989aaf5..add807f3b 100644 --- a/build/docs/WfmIntegrationReference.md +++ b/build/docs/WfmIntegrationReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntegrationResponse.md b/build/docs/WfmIntegrationResponse.md index b54724085..e2193ae57 100644 --- a/build/docs/WfmIntegrationResponse.md +++ b/build/docs/WfmIntegrationResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicErrorBody.md b/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicErrorBody.md index 06f3206fc..863868650 100644 --- a/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicErrorBody.md +++ b/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicErrorBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffType.md b/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffType.md index 6443f5605..898153a75 100644 --- a/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffType.md +++ b/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffType.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffTypesJobNotification.md b/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffTypesJobNotification.md index c09b3f9f4..8c8b02d60 100644 --- a/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffTypesJobNotification.md +++ b/build/docs/WfmIntegrationsHrisTimeOffTypesJobTopicHrisTimeOffTypesJobNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayDataGroup.md b/build/docs/WfmIntradayDataUpdateTopicIntradayDataGroup.md index eb0a7fb33..bb1cf6c98 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayDataGroup.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayDataGroup.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayDataUpdate.md b/build/docs/WfmIntradayDataUpdateTopicIntradayDataUpdate.md index 39be03e02..32b4e7a52 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayDataUpdate.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayDataUpdate.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayForecastData.md b/build/docs/WfmIntradayDataUpdateTopicIntradayForecastData.md index 4323f0647..749f78e73 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayForecastData.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayForecastData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayHistoricalAgentData.md b/build/docs/WfmIntradayDataUpdateTopicIntradayHistoricalAgentData.md index 974cfb205..bdf548be8 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayHistoricalAgentData.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayHistoricalAgentData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayHistoricalQueueData.md b/build/docs/WfmIntradayDataUpdateTopicIntradayHistoricalQueueData.md index b8a348eca..1ae133d69 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayHistoricalQueueData.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayHistoricalQueueData.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayMetric.md b/build/docs/WfmIntradayDataUpdateTopicIntradayMetric.md index 49cc25565..2d25a41b7 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayMetric.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayMetric.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayPerformancePredictionAgentData.md b/build/docs/WfmIntradayDataUpdateTopicIntradayPerformancePredictionAgentData.md index 76bd89514..86bac5c98 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayPerformancePredictionAgentData.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayPerformancePredictionAgentData.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayPerformancePredictionQueueData.md b/build/docs/WfmIntradayDataUpdateTopicIntradayPerformancePredictionQueueData.md index 5745c5461..356777557 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayPerformancePredictionQueueData.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayPerformancePredictionQueueData.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayDataUpdateTopicIntradayScheduleData.md b/build/docs/WfmIntradayDataUpdateTopicIntradayScheduleData.md index e26241dd8..514cc8f46 100644 --- a/build/docs/WfmIntradayDataUpdateTopicIntradayScheduleData.md +++ b/build/docs/WfmIntradayDataUpdateTopicIntradayScheduleData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmIntradayPlanningGroupListing.md b/build/docs/WfmIntradayPlanningGroupListing.md index d240fa99d..08e9a4fc0 100644 --- a/build/docs/WfmIntradayPlanningGroupListing.md +++ b/build/docs/WfmIntradayPlanningGroupListing.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmMoveAgentsCompleteTopicManagementUnit.md b/build/docs/WfmMoveAgentsCompleteTopicManagementUnit.md index 4c01ab6aa..7fc8bbeb9 100644 --- a/build/docs/WfmMoveAgentsCompleteTopicManagementUnit.md +++ b/build/docs/WfmMoveAgentsCompleteTopicManagementUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmMoveAgentsCompleteTopicUserReference.md b/build/docs/WfmMoveAgentsCompleteTopicUserReference.md index 93306242c..91d1bacc2 100644 --- a/build/docs/WfmMoveAgentsCompleteTopicUserReference.md +++ b/build/docs/WfmMoveAgentsCompleteTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmMoveAgentsCompleteTopicWfmMoveAgentData.md b/build/docs/WfmMoveAgentsCompleteTopicWfmMoveAgentData.md index cec9a95d2..dc4f5d0ef 100644 --- a/build/docs/WfmMoveAgentsCompleteTopicWfmMoveAgentData.md +++ b/build/docs/WfmMoveAgentsCompleteTopicWfmMoveAgentData.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmMoveAgentsCompleteTopicWfmMoveAgentsComplete.md b/build/docs/WfmMoveAgentsCompleteTopicWfmMoveAgentsComplete.md index ac8395dd8..4c58a4374 100644 --- a/build/docs/WfmMoveAgentsCompleteTopicWfmMoveAgentsComplete.md +++ b/build/docs/WfmMoveAgentsCompleteTopicWfmMoveAgentsComplete.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmMoveManagementUnitTopicBusinessUnit.md b/build/docs/WfmMoveManagementUnitTopicBusinessUnit.md index 8836f0db6..c1a11bb75 100644 --- a/build/docs/WfmMoveManagementUnitTopicBusinessUnit.md +++ b/build/docs/WfmMoveManagementUnitTopicBusinessUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md b/build/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md index 698963778..2a7986587 100644 --- a/build/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md +++ b/build/docs/WfmMoveManagementUnitTopicMoveManagementUnitNotification.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmProcessUploadRequest.md b/build/docs/WfmProcessUploadRequest.md index 2ef0aad9b..664ef7b11 100644 --- a/build/docs/WfmProcessUploadRequest.md +++ b/build/docs/WfmProcessUploadRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmScheduleActivity.md b/build/docs/WfmScheduleActivity.md index 5cec2a864..509661e91 100644 --- a/build/docs/WfmScheduleActivity.md +++ b/build/docs/WfmScheduleActivity.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmScheduleReference.md b/build/docs/WfmScheduleReference.md index 0661fcccb..b37dcba55 100644 --- a/build/docs/WfmScheduleReference.md +++ b/build/docs/WfmScheduleReference.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmScheduleTopicWfmScheduleNotification.md b/build/docs/WfmScheduleTopicWfmScheduleNotification.md index 447762f0d..f342f514f 100644 --- a/build/docs/WfmScheduleTopicWfmScheduleNotification.md +++ b/build/docs/WfmScheduleTopicWfmScheduleNotification.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmServiceGoalImpact.md b/build/docs/WfmServiceGoalImpact.md index ece005667..52bd6faaa 100644 --- a/build/docs/WfmServiceGoalImpact.md +++ b/build/docs/WfmServiceGoalImpact.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmServiceGoalImpactSettings.md b/build/docs/WfmServiceGoalImpactSettings.md index 9d322e46f..f977e72cf 100644 --- a/build/docs/WfmServiceGoalImpactSettings.md +++ b/build/docs/WfmServiceGoalImpactSettings.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmTimeOffBalanceJobTopicErrorBody.md b/build/docs/WfmTimeOffBalanceJobTopicErrorBody.md index ea601726b..61d44692c 100644 --- a/build/docs/WfmTimeOffBalanceJobTopicErrorBody.md +++ b/build/docs/WfmTimeOffBalanceJobTopicErrorBody.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmTimeOffBalanceJobTopicTimeOffBalance.md b/build/docs/WfmTimeOffBalanceJobTopicTimeOffBalance.md index effb7a728..2b42cffe1 100644 --- a/build/docs/WfmTimeOffBalanceJobTopicTimeOffBalance.md +++ b/build/docs/WfmTimeOffBalanceJobTopicTimeOffBalance.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmTimeOffBalanceJobTopicTimeOffBalanceJobNotification.md b/build/docs/WfmTimeOffBalanceJobTopicTimeOffBalanceJobNotification.md index 87db12b17..a9055f706 100644 --- a/build/docs/WfmTimeOffBalanceJobTopicTimeOffBalanceJobNotification.md +++ b/build/docs/WfmTimeOffBalanceJobTopicTimeOffBalanceJobNotification.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmTimeOffRequestUpdateTopicTimeOffRequestUpdate.md b/build/docs/WfmTimeOffRequestUpdateTopicTimeOffRequestUpdate.md index c4eb35c5e..006d95105 100644 --- a/build/docs/WfmTimeOffRequestUpdateTopicTimeOffRequestUpdate.md +++ b/build/docs/WfmTimeOffRequestUpdateTopicTimeOffRequestUpdate.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmTimeOffRequestUpdateTopicUserReference.md b/build/docs/WfmTimeOffRequestUpdateTopicUserReference.md index 9c209193a..ef2e8b370 100644 --- a/build/docs/WfmTimeOffRequestUpdateTopicUserReference.md +++ b/build/docs/WfmTimeOffRequestUpdateTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUpdateAgentDetailsTopicWfmUpdateAgentDetailsComplete.md b/build/docs/WfmUpdateAgentDetailsTopicWfmUpdateAgentDetailsComplete.md index c3f2cbaf0..e5b0a0403 100644 --- a/build/docs/WfmUpdateAgentDetailsTopicWfmUpdateAgentDetailsComplete.md +++ b/build/docs/WfmUpdateAgentDetailsTopicWfmUpdateAgentDetailsComplete.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserEntityListing.md b/build/docs/WfmUserEntityListing.md index 964559388..8cd81b21e 100644 --- a/build/docs/WfmUserEntityListing.md +++ b/build/docs/WfmUserEntityListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotification.md b/build/docs/WfmUserNotification.md index 04892fcc7..1ca06ffa9 100644 --- a/build/docs/WfmUserNotification.md +++ b/build/docs/WfmUserNotification.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotificationTopicAdherenceExplanationNotification.md b/build/docs/WfmUserNotificationTopicAdherenceExplanationNotification.md index 41426af3e..099d9f191 100644 --- a/build/docs/WfmUserNotificationTopicAdherenceExplanationNotification.md +++ b/build/docs/WfmUserNotificationTopicAdherenceExplanationNotification.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotificationTopicAlternativeShiftNotification.md b/build/docs/WfmUserNotificationTopicAlternativeShiftNotification.md index d7e39eafb..da6580770 100644 --- a/build/docs/WfmUserNotificationTopicAlternativeShiftNotification.md +++ b/build/docs/WfmUserNotificationTopicAlternativeShiftNotification.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotificationTopicBusinessUnit.md b/build/docs/WfmUserNotificationTopicBusinessUnit.md index 1e63389ea..a5a936852 100644 --- a/build/docs/WfmUserNotificationTopicBusinessUnit.md +++ b/build/docs/WfmUserNotificationTopicBusinessUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotificationTopicManagementUnit.md b/build/docs/WfmUserNotificationTopicManagementUnit.md index 16ad84e64..f23e1e9f4 100644 --- a/build/docs/WfmUserNotificationTopicManagementUnit.md +++ b/build/docs/WfmUserNotificationTopicManagementUnit.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotificationTopicShiftTradeNotification.md b/build/docs/WfmUserNotificationTopicShiftTradeNotification.md index ed6a0ef05..895aa0f22 100644 --- a/build/docs/WfmUserNotificationTopicShiftTradeNotification.md +++ b/build/docs/WfmUserNotificationTopicShiftTradeNotification.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotificationTopicTimeOffRequestNotification.md b/build/docs/WfmUserNotificationTopicTimeOffRequestNotification.md index 67f0aaf3b..6a2bb67a4 100644 --- a/build/docs/WfmUserNotificationTopicTimeOffRequestNotification.md +++ b/build/docs/WfmUserNotificationTopicTimeOffRequestNotification.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotificationTopicUserReference.md b/build/docs/WfmUserNotificationTopicUserReference.md index b84120528..fdd74aec6 100644 --- a/build/docs/WfmUserNotificationTopicUserReference.md +++ b/build/docs/WfmUserNotificationTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserNotificationTopicWfmUserNotification.md b/build/docs/WfmUserNotificationTopicWfmUserNotification.md index 793982dcc..327ea934a 100644 --- a/build/docs/WfmUserNotificationTopicWfmUserNotification.md +++ b/build/docs/WfmUserNotificationTopicWfmUserNotification.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicActivityCodeReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicActivityCodeReference.md index 794c69f80..664bafa66 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicActivityCodeReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicActivityCodeReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicQueueReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicQueueReference.md index 413c72daf..670e50528 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicQueueReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicQueueReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicRealTimeAdherenceExplanation.md b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicRealTimeAdherenceExplanation.md index cc1b7af82..176056aff 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicRealTimeAdherenceExplanation.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicRealTimeAdherenceExplanation.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicSecondaryPresenceReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicSecondaryPresenceReference.md index 9856c63bc..ed0c77235 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicSecondaryPresenceReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicSecondaryPresenceReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md index 2abf63bed..20579f158 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserNextActivityReminder.md b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserNextActivityReminder.md index 3df0c2cd5..b67386f5b 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserNextActivityReminder.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserNextActivityReminder.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserReference.md index b66a164e8..f0be6923f 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md index e401136d3..9d67b6ac4 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicActivityCodeReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicActivityCodeReference.md index b88d85bf8..15fd8eaa0 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicActivityCodeReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicActivityCodeReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md index a0c2387d4..714d2fe22 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanation.md b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanation.md index 42e811a4e..3b580ab9b 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanation.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanation.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicSecondaryPresenceReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicSecondaryPresenceReference.md index ad92e46c6..88fe66f9d 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicSecondaryPresenceReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicSecondaryPresenceReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md index 2f23c66d3..f86318942 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserNextActivityReminder.md b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserNextActivityReminder.md index 9a1360f33..15756ccd0 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserNextActivityReminder.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserNextActivityReminder.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md index 54e187cbf..dd4d38140 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md index d625a0ef1..301ac440a 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTeamTopicUserScheduleAdherenceUpdate.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTopicActivityCodeReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTopicActivityCodeReference.md index bb7681978..dde3d02e6 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTopicActivityCodeReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTopicActivityCodeReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTopicQueueReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTopicQueueReference.md index 506a478e0..c7b20e0a1 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTopicQueueReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTopicQueueReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTopicRealTimeAdherenceExplanation.md b/build/docs/WfmUserScheduleAdherenceUpdatedTopicRealTimeAdherenceExplanation.md index a3ec3098c..1bc507848 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTopicRealTimeAdherenceExplanation.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTopicRealTimeAdherenceExplanation.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTopicSecondaryPresenceReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTopicSecondaryPresenceReference.md index e27c01632..d10e4d006 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTopicSecondaryPresenceReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTopicSecondaryPresenceReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md index 9c93aba04..1dc234864 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTopicUriReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserNextActivityReminder.md b/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserNextActivityReminder.md index fbada342f..6148bc16c 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserNextActivityReminder.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserNextActivityReminder.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserReference.md b/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserReference.md index 82720110f..19ee7cc96 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserReference.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md b/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md index 2a0c5f9bf..45379e323 100644 --- a/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md +++ b/build/docs/WfmUserScheduleAdherenceUpdatedTopicUserScheduleAdherenceUpdate.md @@ -29,4 +29,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WfmVersionedEntityMetadata.md b/build/docs/WfmVersionedEntityMetadata.md index 22cab8625..ca93de23f 100644 --- a/build/docs/WfmVersionedEntityMetadata.md +++ b/build/docs/WfmVersionedEntityMetadata.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppAvailablePhoneNumberDetails.md b/build/docs/WhatsAppAvailablePhoneNumberDetails.md index 87111fded..999f6c4be 100644 --- a/build/docs/WhatsAppAvailablePhoneNumberDetails.md +++ b/build/docs/WhatsAppAvailablePhoneNumberDetails.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppAvailablePhoneNumberDetailsListing.md b/build/docs/WhatsAppAvailablePhoneNumberDetailsListing.md index a528f8f58..0b1f93d49 100644 --- a/build/docs/WhatsAppAvailablePhoneNumberDetailsListing.md +++ b/build/docs/WhatsAppAvailablePhoneNumberDetailsListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppDefinition.md b/build/docs/WhatsAppDefinition.md index 60c86b174..61dd91ea9 100644 --- a/build/docs/WhatsAppDefinition.md +++ b/build/docs/WhatsAppDefinition.md @@ -13,4 +13,4 @@ A WhatsApp messaging template definition as defined in the WhatsApp Business Man -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppEmbeddedSignupIntegrationActivationRequest.md b/build/docs/WhatsAppEmbeddedSignupIntegrationActivationRequest.md index cd5ea59e2..c4ebaa68d 100644 --- a/build/docs/WhatsAppEmbeddedSignupIntegrationActivationRequest.md +++ b/build/docs/WhatsAppEmbeddedSignupIntegrationActivationRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppEmbeddedSignupIntegrationRequest.md b/build/docs/WhatsAppEmbeddedSignupIntegrationRequest.md index d95fe39af..12364571a 100644 --- a/build/docs/WhatsAppEmbeddedSignupIntegrationRequest.md +++ b/build/docs/WhatsAppEmbeddedSignupIntegrationRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppId.md b/build/docs/WhatsAppId.md index efb6e1f6b..4747e8010 100644 --- a/build/docs/WhatsAppId.md +++ b/build/docs/WhatsAppId.md @@ -12,4 +12,4 @@ User information for a WhatsApp account -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppIntegration.md b/build/docs/WhatsAppIntegration.md index 6b906b627..327896dba 100644 --- a/build/docs/WhatsAppIntegration.md +++ b/build/docs/WhatsAppIntegration.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppIntegrationEntityListing.md b/build/docs/WhatsAppIntegrationEntityListing.md index 8bdb3030d..ef58d6262 100644 --- a/build/docs/WhatsAppIntegrationEntityListing.md +++ b/build/docs/WhatsAppIntegrationEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppIntegrationRequest.md b/build/docs/WhatsAppIntegrationRequest.md index a19c42ed2..b0214e8e6 100644 --- a/build/docs/WhatsAppIntegrationRequest.md +++ b/build/docs/WhatsAppIntegrationRequest.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WhatsAppIntegrationUpdateRequest.md b/build/docs/WhatsAppIntegrationUpdateRequest.md index 4003cd328..a862e8f23 100644 --- a/build/docs/WhatsAppIntegrationUpdateRequest.md +++ b/build/docs/WhatsAppIntegrationUpdateRequest.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Widget.md b/build/docs/Widget.md index d996f658d..048eafe31 100644 --- a/build/docs/Widget.md +++ b/build/docs/Widget.md @@ -37,4 +37,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WidgetClientConfig.md b/build/docs/WidgetClientConfig.md index 3b0f407c1..2c46b7a40 100644 --- a/build/docs/WidgetClientConfig.md +++ b/build/docs/WidgetClientConfig.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WidgetClientConfigThirdParty.md b/build/docs/WidgetClientConfigThirdParty.md index c243f0723..a3a782696 100644 --- a/build/docs/WidgetClientConfigThirdParty.md +++ b/build/docs/WidgetClientConfigThirdParty.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WidgetClientConfigV1.md b/build/docs/WidgetClientConfigV1.md index 5ac5dd965..3ce8eeb81 100644 --- a/build/docs/WidgetClientConfigV1.md +++ b/build/docs/WidgetClientConfigV1.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WidgetClientConfigV1Http.md b/build/docs/WidgetClientConfigV1Http.md index 1da5edab2..5ee8d711c 100644 --- a/build/docs/WidgetClientConfigV1Http.md +++ b/build/docs/WidgetClientConfigV1Http.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WidgetClientConfigV2.md b/build/docs/WidgetClientConfigV2.md index 0ee440240..b19a9394b 100644 --- a/build/docs/WidgetClientConfigV2.md +++ b/build/docs/WidgetClientConfigV2.md @@ -9,4 +9,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WidgetDeployment.md b/build/docs/WidgetDeployment.md index f62a30a69..ccbfe01cc 100644 --- a/build/docs/WidgetDeployment.md +++ b/build/docs/WidgetDeployment.md @@ -19,4 +19,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WidgetDeploymentEntityListing.md b/build/docs/WidgetDeploymentEntityListing.md index 94c046905..6275aa82c 100644 --- a/build/docs/WidgetDeploymentEntityListing.md +++ b/build/docs/WidgetDeploymentEntityListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WidgetsAPI.md b/build/docs/WidgetsAPI.md index aa6e87163..a25b7a4ac 100644 --- a/build/docs/WidgetsAPI.md +++ b/build/docs/WidgetsAPI.md @@ -264,4 +264,4 @@ WidgetsAPI.putWidgetsDeployment(deploymentId: deploymentId, body: body) { (respo [**WidgetDeployment**](WidgetDeployment) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlan.md b/build/docs/WorkPlan.md index 58142539e..05faca071 100644 --- a/build/docs/WorkPlan.md +++ b/build/docs/WorkPlan.md @@ -42,4 +42,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanActivity.md b/build/docs/WorkPlanActivity.md index ef2b11eff..6a899df46 100644 --- a/build/docs/WorkPlanActivity.md +++ b/build/docs/WorkPlanActivity.md @@ -25,4 +25,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBid.md b/build/docs/WorkPlanBid.md index b6cbc186b..a8a1e7207 100644 --- a/build/docs/WorkPlanBid.md +++ b/build/docs/WorkPlanBid.md @@ -23,4 +23,4 @@ Work plan bid response -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidGroup.md b/build/docs/WorkPlanBidGroup.md index 8715d5eb5..4d5eaf741 100644 --- a/build/docs/WorkPlanBidGroup.md +++ b/build/docs/WorkPlanBidGroup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidGroupCreate.md b/build/docs/WorkPlanBidGroupCreate.md index 6b31e55ec..484aae056 100644 --- a/build/docs/WorkPlanBidGroupCreate.md +++ b/build/docs/WorkPlanBidGroupCreate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidGroupResponse.md b/build/docs/WorkPlanBidGroupResponse.md index c25f821c5..5c914d7a2 100644 --- a/build/docs/WorkPlanBidGroupResponse.md +++ b/build/docs/WorkPlanBidGroupResponse.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidGroupSummary.md b/build/docs/WorkPlanBidGroupSummary.md index edd27b6c2..a0072eaef 100644 --- a/build/docs/WorkPlanBidGroupSummary.md +++ b/build/docs/WorkPlanBidGroupSummary.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidGroupSummaryList.md b/build/docs/WorkPlanBidGroupSummaryList.md index 0f217f439..888b03cd2 100644 --- a/build/docs/WorkPlanBidGroupSummaryList.md +++ b/build/docs/WorkPlanBidGroupSummaryList.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidGroupUpdate.md b/build/docs/WorkPlanBidGroupUpdate.md index 2e61ce805..3a7d18f39 100644 --- a/build/docs/WorkPlanBidGroupUpdate.md +++ b/build/docs/WorkPlanBidGroupUpdate.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidListResponse.md b/build/docs/WorkPlanBidListResponse.md index 3d1c52069..660682e5a 100644 --- a/build/docs/WorkPlanBidListResponse.md +++ b/build/docs/WorkPlanBidListResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidMetadata.md b/build/docs/WorkPlanBidMetadata.md index 709e76483..18e078907 100644 --- a/build/docs/WorkPlanBidMetadata.md +++ b/build/docs/WorkPlanBidMetadata.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBidRanks.md b/build/docs/WorkPlanBidRanks.md index 96ee67841..3230c8beb 100644 --- a/build/docs/WorkPlanBidRanks.md +++ b/build/docs/WorkPlanBidRanks.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanBiddingAdminNotificationTopicWorkPlanBiddingNotification.md b/build/docs/WorkPlanBiddingAdminNotificationTopicWorkPlanBiddingNotification.md index ed343f8bc..c478c085f 100644 --- a/build/docs/WorkPlanBiddingAdminNotificationTopicWorkPlanBiddingNotification.md +++ b/build/docs/WorkPlanBiddingAdminNotificationTopicWorkPlanBiddingNotification.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanConfigurationViolationMessage.md b/build/docs/WorkPlanConfigurationViolationMessage.md index 94bd14275..0a58012d4 100644 --- a/build/docs/WorkPlanConfigurationViolationMessage.md +++ b/build/docs/WorkPlanConfigurationViolationMessage.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanConstraintConflictMessage.md b/build/docs/WorkPlanConstraintConflictMessage.md index f2aaa8af3..9e0e1f378 100644 --- a/build/docs/WorkPlanConstraintConflictMessage.md +++ b/build/docs/WorkPlanConstraintConflictMessage.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanConstraintMessage.md b/build/docs/WorkPlanConstraintMessage.md index 2be2ddcd1..67029ff16 100644 --- a/build/docs/WorkPlanConstraintMessage.md +++ b/build/docs/WorkPlanConstraintMessage.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanListItemResponse.md b/build/docs/WorkPlanListItemResponse.md index 6cf41b6fb..a4ebdbcbf 100644 --- a/build/docs/WorkPlanListItemResponse.md +++ b/build/docs/WorkPlanListItemResponse.md @@ -42,4 +42,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanListResponse.md b/build/docs/WorkPlanListResponse.md index ed75723a9..be9371fe6 100644 --- a/build/docs/WorkPlanListResponse.md +++ b/build/docs/WorkPlanListResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanOverride.md b/build/docs/WorkPlanOverride.md index 863277bba..6f9c51d53 100644 --- a/build/docs/WorkPlanOverride.md +++ b/build/docs/WorkPlanOverride.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanOverrideListWrapperWorkPlanOverrideRequest.md b/build/docs/WorkPlanOverrideListWrapperWorkPlanOverrideRequest.md index 3c5f569ae..5aa167738 100644 --- a/build/docs/WorkPlanOverrideListWrapperWorkPlanOverrideRequest.md +++ b/build/docs/WorkPlanOverrideListWrapperWorkPlanOverrideRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanOverrideRequest.md b/build/docs/WorkPlanOverrideRequest.md index cbfa918ed..3004e9ba3 100644 --- a/build/docs/WorkPlanOverrideRequest.md +++ b/build/docs/WorkPlanOverrideRequest.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanPatternRequest.md b/build/docs/WorkPlanPatternRequest.md index a1c3cffec..f56284320 100644 --- a/build/docs/WorkPlanPatternRequest.md +++ b/build/docs/WorkPlanPatternRequest.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanPatternResponse.md b/build/docs/WorkPlanPatternResponse.md index 90a856736..729d448ff 100644 --- a/build/docs/WorkPlanPatternResponse.md +++ b/build/docs/WorkPlanPatternResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanReference.md b/build/docs/WorkPlanReference.md index cd1f244c6..438ae5067 100644 --- a/build/docs/WorkPlanReference.md +++ b/build/docs/WorkPlanReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanRotationAgentResponse.md b/build/docs/WorkPlanRotationAgentResponse.md index 1f0c7e394..756af2ea6 100644 --- a/build/docs/WorkPlanRotationAgentResponse.md +++ b/build/docs/WorkPlanRotationAgentResponse.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanRotationListResponse.md b/build/docs/WorkPlanRotationListResponse.md index 59bbc0479..cc662bc57 100644 --- a/build/docs/WorkPlanRotationListResponse.md +++ b/build/docs/WorkPlanRotationListResponse.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanRotationReference.md b/build/docs/WorkPlanRotationReference.md index 92c0671aa..8ee62bcbf 100644 --- a/build/docs/WorkPlanRotationReference.md +++ b/build/docs/WorkPlanRotationReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanRotationResponse.md b/build/docs/WorkPlanRotationResponse.md index c8fd2d635..b7ef5fb19 100644 --- a/build/docs/WorkPlanRotationResponse.md +++ b/build/docs/WorkPlanRotationResponse.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanShift.md b/build/docs/WorkPlanShift.md index ba695ba87..76f24ff00 100644 --- a/build/docs/WorkPlanShift.md +++ b/build/docs/WorkPlanShift.md @@ -34,4 +34,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanValidationMessageArgument.md b/build/docs/WorkPlanValidationMessageArgument.md index c92865d1f..38bcc7699 100644 --- a/build/docs/WorkPlanValidationMessageArgument.md +++ b/build/docs/WorkPlanValidationMessageArgument.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkPlanValidationRequest.md b/build/docs/WorkPlanValidationRequest.md index 71ed703ad..acb944578 100644 --- a/build/docs/WorkPlanValidationRequest.md +++ b/build/docs/WorkPlanValidationRequest.md @@ -41,4 +41,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Workbin.md b/build/docs/Workbin.md index 09b578525..864cb4988 100644 --- a/build/docs/Workbin.md +++ b/build/docs/Workbin.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkbinCreate.md b/build/docs/WorkbinCreate.md index 00fd1da98..7a56570ad 100644 --- a/build/docs/WorkbinCreate.md +++ b/build/docs/WorkbinCreate.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkbinQueryEntityListing.md b/build/docs/WorkbinQueryEntityListing.md index 14fc20f37..572e2a56b 100644 --- a/build/docs/WorkbinQueryEntityListing.md +++ b/build/docs/WorkbinQueryEntityListing.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkbinQueryRequest.md b/build/docs/WorkbinQueryRequest.md index f76e7b622..0c785df51 100644 --- a/build/docs/WorkbinQueryRequest.md +++ b/build/docs/WorkbinQueryRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkbinQuerySort.md b/build/docs/WorkbinQuerySort.md index 3f2bd527b..40e2d02c4 100644 --- a/build/docs/WorkbinQuerySort.md +++ b/build/docs/WorkbinQuerySort.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkbinReference.md b/build/docs/WorkbinReference.md index 4c8cdac6d..ec5e5d017 100644 --- a/build/docs/WorkbinReference.md +++ b/build/docs/WorkbinReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkbinUpdate.md b/build/docs/WorkbinUpdate.md index eb3b2930f..93afad9bf 100644 --- a/build/docs/WorkbinUpdate.md +++ b/build/docs/WorkbinUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkdayMetric.md b/build/docs/WorkdayMetric.md index 189c748bc..7953bbbcf 100644 --- a/build/docs/WorkdayMetric.md +++ b/build/docs/WorkdayMetric.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkdayMetricListing.md b/build/docs/WorkdayMetricListing.md index 891d5212e..48e8945a3 100644 --- a/build/docs/WorkdayMetricListing.md +++ b/build/docs/WorkdayMetricListing.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkdayPeriod.md b/build/docs/WorkdayPeriod.md index d8fcac3fb..5e65b2dd9 100644 --- a/build/docs/WorkdayPeriod.md +++ b/build/docs/WorkdayPeriod.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkdayPointsTrend.md b/build/docs/WorkdayPointsTrend.md index 113ac2b6f..4ddc1a0a3 100644 --- a/build/docs/WorkdayPointsTrend.md +++ b/build/docs/WorkdayPointsTrend.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkdayPointsTrendItem.md b/build/docs/WorkdayPointsTrendItem.md index 5515f362e..baa58cfce 100644 --- a/build/docs/WorkdayPointsTrendItem.md +++ b/build/docs/WorkdayPointsTrendItem.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkdayValuesMetricItem.md b/build/docs/WorkdayValuesMetricItem.md index a45f7819f..6ff95905c 100644 --- a/build/docs/WorkdayValuesMetricItem.md +++ b/build/docs/WorkdayValuesMetricItem.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkdayValuesTrend.md b/build/docs/WorkdayValuesTrend.md index d08e559ff..78a072e6f 100644 --- a/build/docs/WorkdayValuesTrend.md +++ b/build/docs/WorkdayValuesTrend.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkdayValuesTrendItem.md b/build/docs/WorkdayValuesTrendItem.md index eb257d486..0bb918f64 100644 --- a/build/docs/WorkdayValuesTrendItem.md +++ b/build/docs/WorkdayValuesTrendItem.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkflowTargetSettings.md b/build/docs/WorkflowTargetSettings.md index 068b02d4a..e8b3be2c3 100644 --- a/build/docs/WorkflowTargetSettings.md +++ b/build/docs/WorkflowTargetSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkforceManagementAPI.md b/build/docs/WorkforceManagementAPI.md index fd750467c..14708e090 100644 --- a/build/docs/WorkforceManagementAPI.md +++ b/build/docs/WorkforceManagementAPI.md @@ -5660,7 +5660,7 @@ WorkforceManagementAPI.getWorkforcemanagementManagementunitUserTimeoffrequestTim -> [TimeOffRequestList](TimeOffRequestList) getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId, recentlyReviewed) +> [TimeOffRequestList](TimeOffRequestList) getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId, userId) Get a list of time off requests for a given user @@ -5682,10 +5682,9 @@ PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." let managementUnitId: String = "" // The ID of the management unit, or 'mine' for the management unit of the logged-in user. let userId: String = "" // The userId to whom the Time Off Request applies. -let recentlyReviewed: Bool = true // Limit results to requests that have been reviewed within the preceding 30 days // Code example -WorkforceManagementAPI.getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId: managementUnitId, userId: userId, recentlyReviewed: recentlyReviewed) { (response, error) in +WorkforceManagementAPI.getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId: managementUnitId, userId: userId) { (response, error) in if let error = error { dump(error) } else if let response = response { @@ -5702,7 +5701,6 @@ WorkforceManagementAPI.getWorkforcemanagementManagementunitUserTimeoffrequests(m | ------------- | ------------- | ------------- | ------------- | | **managementUnitId** | **String**| The ID of the management unit, or 'mine' for the management unit of the logged-in user. | | | **userId** | **String**| The userId to whom the Time Off Request applies. | | -| **recentlyReviewed** | **Bool**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] | ### Return type @@ -6619,7 +6617,7 @@ WorkforceManagementAPI.getWorkforcemanagementTimeoffrequestWaitlistpositions(tim -> [TimeOffRequestList](TimeOffRequestList) getWorkforcemanagementTimeoffrequests(recentlyReviewed) +> [TimeOffRequestList](TimeOffRequestList) getWorkforcemanagementTimeoffrequests() Get a list of time off requests for the current user @@ -6640,10 +6638,9 @@ import PureCloudPlatformClientV2 PureCloudPlatformClientV2API.basePath = "https://api.mypurecloud.com" PureCloudPlatformClientV2API.accessToken = "cwRto9ScT..." -let recentlyReviewed: Bool = true // Limit results to requests that have been reviewed within the preceding 30 days // Code example -WorkforceManagementAPI.getWorkforcemanagementTimeoffrequests(recentlyReviewed: recentlyReviewed) { (response, error) in +WorkforceManagementAPI.getWorkforcemanagementTimeoffrequests() { (response, error) in if let error = error { dump(error) } else if let response = response { @@ -6655,10 +6652,7 @@ WorkforceManagementAPI.getWorkforcemanagementTimeoffrequests(recentlyReviewed: r ### Parameters - -| Name | Type | Description | Notes | -| ------------- | ------------- | ------------- | ------------- | -| **recentlyReviewed** | **Bool**| Limit results to requests that have been reviewed within the preceding 30 days | [optional] | +This endpoint does not require any parameters. ### Return type @@ -13103,4 +13097,4 @@ WorkforceManagementAPI.putWorkforcemanagementManagementunitTimeofflimitValues(ma [**TimeOffLimit**](TimeOffLimit) -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Workitem.md b/build/docs/Workitem.md index 11cbd7f64..af140f611 100644 --- a/build/docs/Workitem.md +++ b/build/docs/Workitem.md @@ -45,4 +45,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemCreate.md b/build/docs/WorkitemCreate.md index 9a147befd..c7e4e90cb 100644 --- a/build/docs/WorkitemCreate.md +++ b/build/docs/WorkitemCreate.md @@ -20,15 +20,15 @@ | **customFields** | [**[String:JSON]**](JSON) | Custom fields defined in the schema referenced by the worktype of the workitem. | [optional] | | **queueId** | **String** | The ID of the Workitems queue. Must be a valid UUID. | [optional] | | **assigneeId** | **String** | The ID of the assignee of the Workitem. Must be a valid UUID. | [optional] | -| **scoredAgents** | [**[WorkitemScoredAgentRequest]**](WorkitemScoredAgentRequest) | A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. | [optional] | | **languageId** | **String** | The ID of language of the Workitem. Must be a valid UUID. | [optional] | | **externalContactId** | **String** | The ID of the external contact of the Workitem. Must be a valid UUID. | [optional] | | **externalTag** | **String** | The external tag of the Workitem. | [optional] | | **skillIds** | **[String]** | The skill IDs of the Workitem. Must be valid UUIDs. | [optional] | -| **preferredAgentIds** | **[String]** | The preferred agent IDs of the Workitem. Must be valid UUIDs. | [optional] | | **wrapupCode** | **String** | The ID of the wrapup. Must be a valid UUID. | [optional] | | **utilizationLabelId** | **String** | The ID of utilization label of the Workitem. Must be a valid UUID. | [optional] | +| **scoredAgents** | [**[WorkitemScoredAgentRequest]**](WorkitemScoredAgentRequest) | A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. | [optional] | +| **preferredAgentIds** | **[String]** | The preferred agent IDs of the Workitem. Must be valid UUIDs. | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemFilter.md b/build/docs/WorkitemFilter.md index bc8e84114..e97c77c6b 100644 --- a/build/docs/WorkitemFilter.md +++ b/build/docs/WorkitemFilter.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemFlowReference.md b/build/docs/WorkitemFlowReference.md index c05c5a5e8..54f218bca 100644 --- a/build/docs/WorkitemFlowReference.md +++ b/build/docs/WorkitemFlowReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemManualAssign.md b/build/docs/WorkitemManualAssign.md index bbb653698..d00e01f23 100644 --- a/build/docs/WorkitemManualAssign.md +++ b/build/docs/WorkitemManualAssign.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnAttributeChangeCondition.md b/build/docs/WorkitemOnAttributeChangeCondition.md index d1290de7c..8e849eb0d 100644 --- a/build/docs/WorkitemOnAttributeChangeCondition.md +++ b/build/docs/WorkitemOnAttributeChangeCondition.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnAttributeChangeConditionUpdate.md b/build/docs/WorkitemOnAttributeChangeConditionUpdate.md index e8490ca42..7a129de0a 100644 --- a/build/docs/WorkitemOnAttributeChangeConditionUpdate.md +++ b/build/docs/WorkitemOnAttributeChangeConditionUpdate.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnAttributeChangeRule.md b/build/docs/WorkitemOnAttributeChangeRule.md index 74e49ef3c..841be05b1 100644 --- a/build/docs/WorkitemOnAttributeChangeRule.md +++ b/build/docs/WorkitemOnAttributeChangeRule.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnAttributeChangeRuleCreate.md b/build/docs/WorkitemOnAttributeChangeRuleCreate.md index e2150e438..4c7aa1c94 100644 --- a/build/docs/WorkitemOnAttributeChangeRuleCreate.md +++ b/build/docs/WorkitemOnAttributeChangeRuleCreate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnAttributeChangeRuleListing.md b/build/docs/WorkitemOnAttributeChangeRuleListing.md index c47d70e97..566dd5fe8 100644 --- a/build/docs/WorkitemOnAttributeChangeRuleListing.md +++ b/build/docs/WorkitemOnAttributeChangeRuleListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnAttributeChangeRuleUpdate.md b/build/docs/WorkitemOnAttributeChangeRuleUpdate.md index 2b22e0773..63ba0ecd5 100644 --- a/build/docs/WorkitemOnAttributeChangeRuleUpdate.md +++ b/build/docs/WorkitemOnAttributeChangeRuleUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnCreateRule.md b/build/docs/WorkitemOnCreateRule.md index 684a6b421..cabe61c3f 100644 --- a/build/docs/WorkitemOnCreateRule.md +++ b/build/docs/WorkitemOnCreateRule.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnCreateRuleCreate.md b/build/docs/WorkitemOnCreateRuleCreate.md index 284aadb8f..1b0b2daaf 100644 --- a/build/docs/WorkitemOnCreateRuleCreate.md +++ b/build/docs/WorkitemOnCreateRuleCreate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnCreateRuleListing.md b/build/docs/WorkitemOnCreateRuleListing.md index 90d4d60dd..1aa167e0b 100644 --- a/build/docs/WorkitemOnCreateRuleListing.md +++ b/build/docs/WorkitemOnCreateRuleListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemOnCreateRuleUpdate.md b/build/docs/WorkitemOnCreateRuleUpdate.md index 376c619fb..3154fa9ad 100644 --- a/build/docs/WorkitemOnCreateRuleUpdate.md +++ b/build/docs/WorkitemOnCreateRuleUpdate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemPagedEntityListing.md b/build/docs/WorkitemPagedEntityListing.md index bd94cd7cf..336af3ed4 100644 --- a/build/docs/WorkitemPagedEntityListing.md +++ b/build/docs/WorkitemPagedEntityListing.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueryJobCreate.md b/build/docs/WorkitemQueryJobCreate.md index 306cd92cb..9da45a7d1 100644 --- a/build/docs/WorkitemQueryJobCreate.md +++ b/build/docs/WorkitemQueryJobCreate.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueryJobError.md b/build/docs/WorkitemQueryJobError.md index df3dd95b8..91ccbfa26 100644 --- a/build/docs/WorkitemQueryJobError.md +++ b/build/docs/WorkitemQueryJobError.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueryJobFilter.md b/build/docs/WorkitemQueryJobFilter.md index 16eda5d48..a8e730561 100644 --- a/build/docs/WorkitemQueryJobFilter.md +++ b/build/docs/WorkitemQueryJobFilter.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueryJobQueryFilters.md b/build/docs/WorkitemQueryJobQueryFilters.md index fbadd5dbd..e39288c20 100644 --- a/build/docs/WorkitemQueryJobQueryFilters.md +++ b/build/docs/WorkitemQueryJobQueryFilters.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueryJobQueryFiltersCriteria.md b/build/docs/WorkitemQueryJobQueryFiltersCriteria.md index aae94285d..067499293 100644 --- a/build/docs/WorkitemQueryJobQueryFiltersCriteria.md +++ b/build/docs/WorkitemQueryJobQueryFiltersCriteria.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueryJobQueryFiltersPredicate.md b/build/docs/WorkitemQueryJobQueryFiltersPredicate.md index e65ba8801..82bee68f0 100644 --- a/build/docs/WorkitemQueryJobQueryFiltersPredicate.md +++ b/build/docs/WorkitemQueryJobQueryFiltersPredicate.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueryJobResponse.md b/build/docs/WorkitemQueryJobResponse.md index ba36be0bd..5d60b9e5c 100644 --- a/build/docs/WorkitemQueryJobResponse.md +++ b/build/docs/WorkitemQueryJobResponse.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueryJobSort.md b/build/docs/WorkitemQueryJobSort.md index 10aceeeaf..14664820d 100644 --- a/build/docs/WorkitemQueryJobSort.md +++ b/build/docs/WorkitemQueryJobSort.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemQueueReference.md b/build/docs/WorkitemQueueReference.md index 81a748e28..32a6f94af 100644 --- a/build/docs/WorkitemQueueReference.md +++ b/build/docs/WorkitemQueueReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemReference.md b/build/docs/WorkitemReference.md index a1deda7f5..92d5dd5f0 100644 --- a/build/docs/WorkitemReference.md +++ b/build/docs/WorkitemReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemRuleAction.md b/build/docs/WorkitemRuleAction.md index af881150c..66661d558 100644 --- a/build/docs/WorkitemRuleAction.md +++ b/build/docs/WorkitemRuleAction.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemRuleSettings.md b/build/docs/WorkitemRuleSettings.md index 6bfa74644..4542c2c5c 100644 --- a/build/docs/WorkitemRuleSettings.md +++ b/build/docs/WorkitemRuleSettings.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemSchema.md b/build/docs/WorkitemSchema.md index e099d3cd9..6ff612982 100644 --- a/build/docs/WorkitemSchema.md +++ b/build/docs/WorkitemSchema.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemScoredAgent.md b/build/docs/WorkitemScoredAgent.md index 09887e36e..7383aa675 100644 --- a/build/docs/WorkitemScoredAgent.md +++ b/build/docs/WorkitemScoredAgent.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemScoredAgentRequest.md b/build/docs/WorkitemScoredAgentRequest.md index b79305e4a..2bec1b396 100644 --- a/build/docs/WorkitemScoredAgentRequest.md +++ b/build/docs/WorkitemScoredAgentRequest.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemScriptReference.md b/build/docs/WorkitemScriptReference.md index f3f8af8fe..04aa76d1e 100644 --- a/build/docs/WorkitemScriptReference.md +++ b/build/docs/WorkitemScriptReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemStatus.md b/build/docs/WorkitemStatus.md index 096f2a0d9..bb5e5165a 100644 --- a/build/docs/WorkitemStatus.md +++ b/build/docs/WorkitemStatus.md @@ -20,4 +20,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemStatusCreate.md b/build/docs/WorkitemStatusCreate.md index d4b5464db..3c5546a34 100644 --- a/build/docs/WorkitemStatusCreate.md +++ b/build/docs/WorkitemStatusCreate.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemStatusFilter.md b/build/docs/WorkitemStatusFilter.md index 3fc656b3e..2889f44e1 100644 --- a/build/docs/WorkitemStatusFilter.md +++ b/build/docs/WorkitemStatusFilter.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemStatusListing.md b/build/docs/WorkitemStatusListing.md index a42d8e8ea..baff1d376 100644 --- a/build/docs/WorkitemStatusListing.md +++ b/build/docs/WorkitemStatusListing.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemStatusReference.md b/build/docs/WorkitemStatusReference.md index 67041802f..71d254272 100644 --- a/build/docs/WorkitemStatusReference.md +++ b/build/docs/WorkitemStatusReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemStatusUpdate.md b/build/docs/WorkitemStatusUpdate.md index 4722b29ca..d8dacb037 100644 --- a/build/docs/WorkitemStatusUpdate.md +++ b/build/docs/WorkitemStatusUpdate.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemTerminate.md b/build/docs/WorkitemTerminate.md index 76e691596..fee2a7560 100644 --- a/build/docs/WorkitemTerminate.md +++ b/build/docs/WorkitemTerminate.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemUpdate.md b/build/docs/WorkitemUpdate.md index 5237ceee8..70c6aefd9 100644 --- a/build/docs/WorkitemUpdate.md +++ b/build/docs/WorkitemUpdate.md @@ -32,4 +32,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemUtilizationLabelReference.md b/build/docs/WorkitemUtilizationLabelReference.md index d7826c808..e12c6c367 100644 --- a/build/docs/WorkitemUtilizationLabelReference.md +++ b/build/docs/WorkitemUtilizationLabelReference.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemWrapup.md b/build/docs/WorkitemWrapup.md index 3de21892e..d2aeb6d0b 100644 --- a/build/docs/WorkitemWrapup.md +++ b/build/docs/WorkitemWrapup.md @@ -14,4 +14,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemWrapupEntityListing.md b/build/docs/WorkitemWrapupEntityListing.md index fcdc8272a..1679680ef 100644 --- a/build/docs/WorkitemWrapupEntityListing.md +++ b/build/docs/WorkitemWrapupEntityListing.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemWrapupUpdate.md b/build/docs/WorkitemWrapupUpdate.md index 12131f4c7..635b97fd6 100644 --- a/build/docs/WorkitemWrapupUpdate.md +++ b/build/docs/WorkitemWrapupUpdate.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsEventsNotificationAssignmentSegment.md b/build/docs/WorkitemsEventsNotificationAssignmentSegment.md index d51c0f936..e97f27dbd 100644 --- a/build/docs/WorkitemsEventsNotificationAssignmentSegment.md +++ b/build/docs/WorkitemsEventsNotificationAssignmentSegment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsEventsNotificationCustomAttribute.md b/build/docs/WorkitemsEventsNotificationCustomAttribute.md index 25280b322..bff25f87a 100644 --- a/build/docs/WorkitemsEventsNotificationCustomAttribute.md +++ b/build/docs/WorkitemsEventsNotificationCustomAttribute.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsEventsNotificationDelta.md b/build/docs/WorkitemsEventsNotificationDelta.md index 08b987466..0269cbca2 100644 --- a/build/docs/WorkitemsEventsNotificationDelta.md +++ b/build/docs/WorkitemsEventsNotificationDelta.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsEventsNotificationSession.md b/build/docs/WorkitemsEventsNotificationSession.md index e0ec0d756..219b13d19 100644 --- a/build/docs/WorkitemsEventsNotificationSession.md +++ b/build/docs/WorkitemsEventsNotificationSession.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsEventsNotificationWorkitem.md b/build/docs/WorkitemsEventsNotificationWorkitem.md index e5e7f051e..e0e7a32d0 100644 --- a/build/docs/WorkitemsEventsNotificationWorkitem.md +++ b/build/docs/WorkitemsEventsNotificationWorkitem.md @@ -43,4 +43,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsEventsNotificationWrapup.md b/build/docs/WorkitemsEventsNotificationWrapup.md index 361bc58ca..249d975f2 100644 --- a/build/docs/WorkitemsEventsNotificationWrapup.md +++ b/build/docs/WorkitemsEventsNotificationWrapup.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsQueueEventsNotificationAssignmentSegment.md b/build/docs/WorkitemsQueueEventsNotificationAssignmentSegment.md index 62f17a402..033a80984 100644 --- a/build/docs/WorkitemsQueueEventsNotificationAssignmentSegment.md +++ b/build/docs/WorkitemsQueueEventsNotificationAssignmentSegment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsQueueEventsNotificationCustomAttribute.md b/build/docs/WorkitemsQueueEventsNotificationCustomAttribute.md index 0456d12a5..995fbba43 100644 --- a/build/docs/WorkitemsQueueEventsNotificationCustomAttribute.md +++ b/build/docs/WorkitemsQueueEventsNotificationCustomAttribute.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsQueueEventsNotificationDelta.md b/build/docs/WorkitemsQueueEventsNotificationDelta.md index 8d83fd343..7f7f0ab28 100644 --- a/build/docs/WorkitemsQueueEventsNotificationDelta.md +++ b/build/docs/WorkitemsQueueEventsNotificationDelta.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsQueueEventsNotificationSession.md b/build/docs/WorkitemsQueueEventsNotificationSession.md index 4829ceed2..09b3ec077 100644 --- a/build/docs/WorkitemsQueueEventsNotificationSession.md +++ b/build/docs/WorkitemsQueueEventsNotificationSession.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsQueueEventsNotificationWorkitem.md b/build/docs/WorkitemsQueueEventsNotificationWorkitem.md index 79236784a..c952bc3a6 100644 --- a/build/docs/WorkitemsQueueEventsNotificationWorkitem.md +++ b/build/docs/WorkitemsQueueEventsNotificationWorkitem.md @@ -43,4 +43,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsQueueEventsNotificationWrapup.md b/build/docs/WorkitemsQueueEventsNotificationWrapup.md index b236c5790..3b80e3069 100644 --- a/build/docs/WorkitemsQueueEventsNotificationWrapup.md +++ b/build/docs/WorkitemsQueueEventsNotificationWrapup.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsUserEventsNotificationAssignmentSegment.md b/build/docs/WorkitemsUserEventsNotificationAssignmentSegment.md index abb5ad065..da5ee433a 100644 --- a/build/docs/WorkitemsUserEventsNotificationAssignmentSegment.md +++ b/build/docs/WorkitemsUserEventsNotificationAssignmentSegment.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsUserEventsNotificationCustomAttribute.md b/build/docs/WorkitemsUserEventsNotificationCustomAttribute.md index 080deaa99..eec0e6f08 100644 --- a/build/docs/WorkitemsUserEventsNotificationCustomAttribute.md +++ b/build/docs/WorkitemsUserEventsNotificationCustomAttribute.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsUserEventsNotificationDelta.md b/build/docs/WorkitemsUserEventsNotificationDelta.md index 25d352605..15a57d163 100644 --- a/build/docs/WorkitemsUserEventsNotificationDelta.md +++ b/build/docs/WorkitemsUserEventsNotificationDelta.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsUserEventsNotificationSession.md b/build/docs/WorkitemsUserEventsNotificationSession.md index d4ad2fd26..8840e9448 100644 --- a/build/docs/WorkitemsUserEventsNotificationSession.md +++ b/build/docs/WorkitemsUserEventsNotificationSession.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsUserEventsNotificationWorkitem.md b/build/docs/WorkitemsUserEventsNotificationWorkitem.md index 4d1928a96..023513713 100644 --- a/build/docs/WorkitemsUserEventsNotificationWorkitem.md +++ b/build/docs/WorkitemsUserEventsNotificationWorkitem.md @@ -43,4 +43,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkitemsUserEventsNotificationWrapup.md b/build/docs/WorkitemsUserEventsNotificationWrapup.md index 8043fcfbd..d15a19045 100644 --- a/build/docs/WorkitemsUserEventsNotificationWrapup.md +++ b/build/docs/WorkitemsUserEventsNotificationWrapup.md @@ -13,4 +13,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Workspace.md b/build/docs/Workspace.md index 60feb23fd..7c9d63107 100644 --- a/build/docs/Workspace.md +++ b/build/docs/Workspace.md @@ -21,4 +21,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkspaceCreate.md b/build/docs/WorkspaceCreate.md index 7aa779367..598447f78 100644 --- a/build/docs/WorkspaceCreate.md +++ b/build/docs/WorkspaceCreate.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkspaceEntityListing.md b/build/docs/WorkspaceEntityListing.md index 1095f2bef..f6dbe0df3 100644 --- a/build/docs/WorkspaceEntityListing.md +++ b/build/docs/WorkspaceEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkspaceMember.md b/build/docs/WorkspaceMember.md index 364d8c222..38e48a802 100644 --- a/build/docs/WorkspaceMember.md +++ b/build/docs/WorkspaceMember.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkspaceMemberEntityListing.md b/build/docs/WorkspaceMemberEntityListing.md index b796569b9..98e7fc715 100644 --- a/build/docs/WorkspaceMemberEntityListing.md +++ b/build/docs/WorkspaceMemberEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorkspaceSummary.md b/build/docs/WorkspaceSummary.md index d53f8307a..8591d6926 100644 --- a/build/docs/WorkspaceSummary.md +++ b/build/docs/WorkspaceSummary.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Worktype.md b/build/docs/Worktype.md index 7abc632d4..340536d97 100644 --- a/build/docs/Worktype.md +++ b/build/docs/Worktype.md @@ -33,4 +33,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorktypeCreate.md b/build/docs/WorktypeCreate.md index 035311045..d53d4fce5 100644 --- a/build/docs/WorktypeCreate.md +++ b/build/docs/WorktypeCreate.md @@ -27,4 +27,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorktypeQueryEntityListing.md b/build/docs/WorktypeQueryEntityListing.md index f2d814c9f..facd1fe50 100644 --- a/build/docs/WorktypeQueryEntityListing.md +++ b/build/docs/WorktypeQueryEntityListing.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorktypeQueryRequest.md b/build/docs/WorktypeQueryRequest.md index b412f08a9..6896b843e 100644 --- a/build/docs/WorktypeQueryRequest.md +++ b/build/docs/WorktypeQueryRequest.md @@ -15,4 +15,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorktypeQuerySort.md b/build/docs/WorktypeQuerySort.md index 6f547bebf..3fd8ce71c 100644 --- a/build/docs/WorktypeQuerySort.md +++ b/build/docs/WorktypeQuerySort.md @@ -11,4 +11,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorktypeReference.md b/build/docs/WorktypeReference.md index ab93001e2..7c6ac86a7 100644 --- a/build/docs/WorktypeReference.md +++ b/build/docs/WorktypeReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WorktypeUpdate.md b/build/docs/WorktypeUpdate.md index ced50bf6e..9f1e36975 100644 --- a/build/docs/WorktypeUpdate.md +++ b/build/docs/WorktypeUpdate.md @@ -26,4 +26,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapUpCodeConfig.md b/build/docs/WrapUpCodeConfig.md index 07a2e130a..1f378d462 100644 --- a/build/docs/WrapUpCodeConfig.md +++ b/build/docs/WrapUpCodeConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapUpCodeMapping.md b/build/docs/WrapUpCodeMapping.md index 46d98f803..4c249d37b 100644 --- a/build/docs/WrapUpCodeMapping.md +++ b/build/docs/WrapUpCodeMapping.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapUpCodeReference.md b/build/docs/WrapUpCodeReference.md index c7c4a7090..077fba2c3 100644 --- a/build/docs/WrapUpCodeReference.md +++ b/build/docs/WrapUpCodeReference.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/Wrapup.md b/build/docs/Wrapup.md index d83da065d..fccc394f1 100644 --- a/build/docs/Wrapup.md +++ b/build/docs/Wrapup.md @@ -16,4 +16,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapupCode.md b/build/docs/WrapupCode.md index b8342b71d..90caec7b2 100644 --- a/build/docs/WrapupCode.md +++ b/build/docs/WrapupCode.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapupCodeEntityListing.md b/build/docs/WrapupCodeEntityListing.md index b66e64e53..97981b7e3 100644 --- a/build/docs/WrapupCodeEntityListing.md +++ b/build/docs/WrapupCodeEntityListing.md @@ -10,13 +10,13 @@ | **pageSize** | **Int** | | [optional] | | **pageNumber** | **Int** | | [optional] | | **total** | **Int64** | | [optional] | -| **nextUri** | **String** | | [optional] | -| **previousUri** | **String** | | [optional] | -| **lastUri** | **String** | | [optional] | | **firstUri** | **String** | | [optional] | +| **lastUri** | **String** | | [optional] | | **selfUri** | **String** | | [optional] | +| **nextUri** | **String** | | [optional] | +| **previousUri** | **String** | | [optional] | | **pageCount** | **Int** | | [optional] | -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapupCodePredictionConfig.md b/build/docs/WrapupCodePredictionConfig.md index 409c8e77a..6c0e69183 100644 --- a/build/docs/WrapupCodePredictionConfig.md +++ b/build/docs/WrapupCodePredictionConfig.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapupCodeRequest.md b/build/docs/WrapupCodeRequest.md index f56cf682e..2ccc67076 100644 --- a/build/docs/WrapupCodeRequest.md +++ b/build/docs/WrapupCodeRequest.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapupDetailEventTopicWrapupEvent.md b/build/docs/WrapupDetailEventTopicWrapupEvent.md index 9dd944c41..494a0b580 100644 --- a/build/docs/WrapupDetailEventTopicWrapupEvent.md +++ b/build/docs/WrapupDetailEventTopicWrapupEvent.md @@ -31,4 +31,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapupIdReference.md b/build/docs/WrapupIdReference.md index 59e7dd1ef..34cb364b6 100644 --- a/build/docs/WrapupIdReference.md +++ b/build/docs/WrapupIdReference.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WrapupInput.md b/build/docs/WrapupInput.md index 6d942081e..38300606e 100644 --- a/build/docs/WrapupInput.md +++ b/build/docs/WrapupInput.md @@ -17,4 +17,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WritableDialerContact.md b/build/docs/WritableDialerContact.md index 2e524fcae..fa7c58d9d 100644 --- a/build/docs/WritableDialerContact.md +++ b/build/docs/WritableDialerContact.md @@ -18,4 +18,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WritableDivision.md b/build/docs/WritableDivision.md index 77289f47d..4b7075db1 100644 --- a/build/docs/WritableDivision.md +++ b/build/docs/WritableDivision.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WritableEntity.md b/build/docs/WritableEntity.md index 718304b90..735b4b2df 100644 --- a/build/docs/WritableEntity.md +++ b/build/docs/WritableEntity.md @@ -10,4 +10,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/WritableStarrableDivision.md b/build/docs/WritableStarrableDivision.md index eb87e9aa7..d9a0ae9f7 100644 --- a/build/docs/WritableStarrableDivision.md +++ b/build/docs/WritableStarrableDivision.md @@ -12,4 +12,4 @@ -_PureCloudPlatformClientV2@157.0.0_ +_PureCloudPlatformClientV2@158.0.0_ diff --git a/build/docs/index.md b/build/docs/index.md index 941e85b16..855ec12dc 100644 --- a/build/docs/index.md +++ b/build/docs/index.md @@ -2,7 +2,7 @@ The iOS SDK is compatible with Swift 5 and does not require any external dependencies. Documentation can be found at https://mypurecloud.github.io/platform-client-sdk-ios/. -Documentation version PureCloudPlatformClientV2@157.0.0 +Documentation version PureCloudPlatformClientV2@158.0.0 ## Install using CocoaPods @@ -12,7 +12,7 @@ This package's source is on github at https://github.com/MyPureCloud/platform-cl Reference the SDK's pod in your project's Podfile: ``` -pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '157.0.0' +pod 'PureCloudPlatformClientV2', :git => 'https://github.com/MyPureCloud/platform-client-sdk-ios.git', :tag => '158.0.0' ``` Then install your project's dependencies: diff --git a/build/docs/releaseNotes.md b/build/docs/releaseNotes.md index 5e6d07d49..f459a3f02 100644 --- a/build/docs/releaseNotes.md +++ b/build/docs/releaseNotes.md @@ -1,327 +1,233 @@ -Platform API version: 8669 +Platform API version: 8698 -# Major Changes (9 changes) +# Major Changes (8 changes) -**/api/v2/routing/sms/phonenumbers/{addressId}** (1 change) +**GET /api/v2/externalcontacts/contacts/{contactId}/identifiers** (1 change) -* Path /api/v2/routing/sms/phonenumbers/{addressId} was removed +* Response 200 type was changed from EntityListing to ContactIdentifierListing -**GET /api/v2/knowledge/integrations/{integrationId}/options** (1 change) +**GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests** (1 change) -* Parameter knowledgeBaseIds was added +* Parameter recentlyReviewed was removed -**GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime** (1 change) +**GET /api/v2/workforcemanagement/timeoffrequests** (1 change) -* Parameter labelId was added +* Parameter recentlyReviewed was removed -**GET /api/v2/quality/agents/activity** (1 change) +**QuestionGroupSettings** (1 change) -* Parameter userState was added +* Property questionGroupIndex was removed -**GET /api/v2/quality/evaluations/query** (1 change) +**QuestionSettings** (1 change) -* Parameter includeDeletedUsers was added +* Property questionIndex was removed -**CampaignSchedule** (1 change) +**BatchDownloadJobResult** (3 changes) -* Property campaign was changed from DomainEntityRef to DivisionedDomainEntityRef +* Property id was removed +* Property name was removed +* Property selfUri was removed -**EmailCampaignSchedule** (1 change) -* Property emailCampaign was changed from DomainEntityRef to DivisionedDomainEntityRef +# Minor Changes (50 changes) -**MessagingCampaignSchedule** (1 change) - -* Property messagingCampaign was changed from DomainEntityRef to DivisionedDomainEntityRef - -**ValidationServiceRequest** (1 change) - -* Property fileName was removed - - -# Minor Changes (68 changes) - -**/api/v2/conversations/{conversationId}/summaries** (2 changes) +**/api/v2/externalcontacts/import/jobs/{jobId}** (3 changes) * Path was added * Operation GET was added +* Operation PUT was added -**/api/v2/usage/events/query** (2 changes) - -* Path was added -* Operation POST was added - -**/api/v2/usage/events/aggregates/query** (2 changes) +**/api/v2/externalcontacts/import/jobs** (3 changes) * Path was added +* Operation GET was added * Operation POST was added -**POST /api/v2/routing/email/domains/{domainName}/routes** (1 change) - -* Response 202 was added - -**/api/v2/routing/sms/phonenumbers/{phoneNumberId}** (4 changes) +**/api/v2/externalcontacts/import/settings/{settingsId}** (4 changes) * Path was added * Operation GET was added * Operation PUT was added * Operation DELETE was added -**GET /api/v2/voicemail/me/mailbox** (1 change) - -* Response 502 was added - -**OrgAuthSettings** (1 change) - -* Optional property inactivityTimeoutExclusions was added - -**AgentCopilotAggregateQueryPredicate** (1 change) - -* Enum value hasAnswerHighlight was added to property dimension +**/api/v2/externalcontacts/import/settings** (3 changes) -**AgentCopilotAggregationQuery** (1 change) - -* Enum value hasAnswerHighlight was added to property groupBy - -**ViewFilter** (2 changes) - -* Enum value apple was added to property messageTypes -* Optional property conferenced was added - -**ReportingExportJobResponse** (1 change) - -* Enum value AGENT_COPILOT_PERFORMANCE_VIEW was added to property viewType - -**ReportingExportMetadataJobResponse** (1 change) - -* Enum value AGENT_COPILOT_PERFORMANCE_VIEW was added to property viewType - -**ReportingExportJobRequest** (1 change) - -* Enum value AGENT_COPILOT_PERFORMANCE_VIEW was added to property viewType - -**EvaluationForm** (1 change) - -* Optional property evaluationSettings was added - -**EvaluationSettings** (4 changes) - -* Optional property revisionsEnabled was added -* Optional property disputesEnabled was added -* Optional property disputesAllowedPerEvaluation was added -* Optional property disputesAssignees was added +* Path was added +* Operation GET was added +* Operation POST was added -**EvaluationSettingsAssignee** (2 changes) +**/api/v2/dataprivacy/maskingrules/{ruleId}** (4 changes) -* Optional property user was added -* Optional property type was added +* Path was added +* Operation GET was added +* Operation DELETE was added +* Operation PATCH was added -**WrapupCode** (1 change) +**/api/v2/dataprivacy/maskingrules** (3 changes) -* Optional property description was added +* Path was added +* Operation GET was added +* Operation POST was added -**Session** (1 change) +**/api/v2/dataprivacy/maskingrules/validate** (2 changes) -* Optional property divisionIds was added +* Path was added +* Operation POST was added -**ConversationEventTyping** (1 change) +**PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}** (1 change) -* duration is no longer readonly +* Response 202 was added -**MessagingIntegration** (1 change) +**DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}** (1 change) -* Enum value Failed was added to property status +* Response 202 was added -**OpenMessagingIdentityResolutionConfig** (1 change) +**ContactIdentifierListing** (1 change) * Model was added -**WhatsAppIntegration** (1 change) +**ContactImportJobStatusUpdateResponse** (1 change) -* Enum value Failed was added to property status +* Model was added -**ConversationEditedSummary** (1 change) +**ContactImportJobStatusUpdateRequest** (1 change) * Model was added -**ConversationSessionSummary** (1 change) +**ContactImportJobMetadata** (1 change) * Model was added -**ConversationSummariesGetResponse** (1 change) +**ContactImportJobResponse** (1 change) * Model was added -**ConversationSummary** (1 change) +**ContactImportJobRequest** (1 change) * Model was added -**ConversationSummaryFollowup** (1 change) +**ContactImportJobEntityListing** (1 change) * Model was added -**ConversationSummaryReason** (1 change) +**ContactImportField** (1 change) * Model was added -**ConversationSummaryResolution** (1 change) +**ContactImportSettings** (1 change) * Model was added -**ConversationSummaryWrapupCode** (1 change) +**ContactImportSettingsEntityListing** (1 change) * Model was added -**CampaignRuleCondition** (1 change) +**ConversationMessageMetadataContent** (1 change) -* Enum value campaignContactsMessaged was added to property conditionType +* Enum value DatePicker was added to property contentType -**CampaignRuleWarningParameters** (1 change) +**ConversationContentButtonResponse** (1 change) -* Enum value campaignContactsMessaged was added to property conditionType +* Enum value DatePicker was added to property type -**DivisionedDomainEntityRef** (1 change) +**ConversationContentDatePicker** (1 change) * Model was added -**JourneyViewElement** (1 change) - -* Optional property displayAttributes was added - -**JourneyViewElementDisplayAttributes** (1 change) +**ConversationContentDatePickerAvailableTime** (1 change) * Model was added -**KnowledgeIntegrationFilter** (1 change) +**ConversationMessageContent** (1 change) -* Optional property action was added - -**KnowledgeExportJobDocumentsFilter** (1 change) - -* Optional property includeDocumentsWithFileBody was added - -**Miner** (1 change) - -* Enum value nl-nl was added to property language - -**KnowledgeGuestSession** (1 change) - -* Optional property journeySessionId was added - -**EventQueryResponse** (1 change) - -* Model was added +* Enum value DatePicker was added to property contentType -**OperationalEvent** (1 change) +**MaskingRule** (1 change) * Model was added -**EventQueryRequest** (1 change) +**MaskingRuleListing** (1 change) * Model was added -**EventAggregatesResponse** (1 change) +**MaskingRuleValidateResponse** (1 change) * Model was added -**EventDefinitionAggregates** (1 change) +**MaskingRuleValidateRequest** (1 change) * Model was added -**EventAggregatesQueryRequest** (1 change) +**KnowledgeIntegrationDefaultSettings** (1 change) * Model was added -**PredictionResults** (1 change) +**SalesforceSettings** (1 change) -* Optional property label was added +* Optional property baseUrl was added -**BatchDownloadJobStatusResult** (1 change) +**ServiceNowSettings** (1 change) -* Optional property status was added +* Optional property baseUrl was added -**EvaluationFormResponse** (1 change) +**RegionTimeZone** (1 change) -* Optional property evaluationSettings was added +* Optional property canonicalId was added -**WrapupCodeRequest** (1 change) +**Dependency** (1 change) -* Optional property description was added +* Enum value SMSPHONENUMBER was added to property type -**ScimV2EnterpriseUser** (1 change) +**DependencyObject** (1 change) -* Optional property dateHire was added +* Enum value SMSPHONENUMBER was added to property type -**UserMe** (1 change) +**CobrowseSettings** (1 change) -* Optional property autoAnswerSettings was added - -**ArchitectJobStateResponse** (1 change) - -* Enum value Export was added to property command - -**SupportCenterLabelFilter** (1 change) - -* Model was added - -**SupportCenterSettings** (1 change) - -* Optional property labelFilter was added - -**WorkitemScriptReference** (1 change) - -* Model was added - -**WorkitemOnAttributeChangeRule** (1 change) - -* Enum value Date was added to property type - -**WorkitemOnCreateRule** (1 change) - -* Enum value Date was added to property type +* Optional property allowDraw was added # Point Changes (10 changes) -**GET /api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns** (1 change) +**GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest** (1 change) * Description was changed -**GET /api/v2/analytics/botflows/{botFlowId}/reportingturns** (1 change) +**GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}** (1 change) * Description was changed -**GET /api/v2/analytics/botflows/{botFlowId}/sessions** (1 change) +**PATCH /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}** (1 change) * Description was changed -**POST /api/v2/routing/email/domains/{domainName}/routes** (1 change) +**POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs** (1 change) -* Response 200 was changed from successful operation to Route create completed. +* Description was changed -**POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search** (1 change) +**GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results** (1 change) -* Description was changed for parameter weekDateId +* Description was changed -**GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades** (1 change) +**GET /api/v2/journey/views/{viewId}/schedules** (1 change) -* Description was changed for parameter weekDateId +* Description was changed -**POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades** (1 change) +**PUT /api/v2/journey/views/{viewId}/schedules** (1 change) -* Description was changed for parameter weekDateId +* Description was changed -**POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk** (1 change) +**DELETE /api/v2/journey/views/{viewId}/schedules** (1 change) -* Description was changed for parameter weekDateId +* Description was changed -**PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}** (1 change) +**PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}** (1 change) -* Description was changed for parameter weekDateId +* Response 200 was changed from successful operation to Route update completed. -**POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match** (1 change) +**DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}** (1 change) -* Description was changed for parameter weekDateId +* Response 200 was changed from Operation was successful. to Route deletion completed. diff --git a/build/src/APIs/ArchitectAPI.swift b/build/src/APIs/ArchitectAPI.swift index ac26ed87d..e4d0f4632 100644 --- a/build/src/APIs/ArchitectAPI.swift +++ b/build/src/APIs/ArchitectAPI.swift @@ -1705,6 +1705,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -1785,6 +1786,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -1861,6 +1863,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -2183,6 +2186,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -2260,6 +2264,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -2436,6 +2441,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -2513,6 +2519,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -2702,6 +2709,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -2787,6 +2795,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -3044,6 +3053,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -3125,6 +3135,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -3201,6 +3212,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -3537,6 +3549,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -3615,6 +3628,7 @@ open class ArchitectAPI { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" diff --git a/build/src/APIs/DataPrivacyAPI.swift b/build/src/APIs/DataPrivacyAPI.swift new file mode 100644 index 000000000..2efd4bc81 --- /dev/null +++ b/build/src/APIs/DataPrivacyAPI.swift @@ -0,0 +1,374 @@ +// +// DataPrivacyAPI.swift +// +// Generated by swagger-codegen +// https://github.com/swagger-api/swagger-codegen +// + +import Foundation + + + +open class DataPrivacyAPI { + + + /** + Delete a masking rule. + + - parameter ruleId: (path) ruleId + - parameter completion: completion handler to receive the data and the error objects + */ + open class func deleteDataprivacyMaskingrule(ruleId: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) { + let requestBuilder = deleteDataprivacyMaskingruleWithRequestBuilder(ruleId: ruleId) + requestBuilder.execute { (response: Response?, error) -> Void in + if error == nil { + completion((), error) + } else { + completion(nil, error) + } + } + } + + /** + Delete a masking rule. + - DELETE /api/v2/dataprivacy/maskingrules/{ruleId} + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + + - parameter ruleId: (path) ruleId + + - returns: RequestBuilder + */ + open class func deleteDataprivacyMaskingruleWithRequestBuilder(ruleId: String) -> RequestBuilder { + var path = "/api/v2/dataprivacy/maskingrules/{ruleId}" + let ruleIdPreEscape = "\(ruleId)" + let ruleIdPostEscape = ruleIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" + path = path.replacingOccurrences(of: "{ruleId}", with: ruleIdPostEscape, options: .literal, range: nil) + let URLString = PureCloudPlatformClientV2API.basePath + path + let body: Data? = nil + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "DELETE", url: requestUrl!, body: body) + } + + + + /** + Fetch details about a masking rule. + + - parameter ruleId: (path) ruleId + - parameter completion: completion handler to receive the data and the error objects + */ + open class func getDataprivacyMaskingrule(ruleId: String, completion: @escaping ((_ data: MaskingRule?,_ error: Error?) -> Void)) { + let requestBuilder = getDataprivacyMaskingruleWithRequestBuilder(ruleId: ruleId) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Fetch details about a masking rule. + - GET /api/v2/dataprivacy/maskingrules/{ruleId} + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "substituteCharacter" : "substituteCharacter", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "name" : "name", + "description" : "description", + "definition" : "definition", + "dateModified" : "2000-01-23T04:56:07.000+00:00", + "id" : "id", + "type" : "Custom", + "integrations" : [ "integrations", "integrations" ], + "enabled" : true +}, statusCode=200}] + + - parameter ruleId: (path) ruleId + + - returns: RequestBuilder + */ + open class func getDataprivacyMaskingruleWithRequestBuilder(ruleId: String) -> RequestBuilder { + var path = "/api/v2/dataprivacy/maskingrules/{ruleId}" + let ruleIdPreEscape = "\(ruleId)" + let ruleIdPostEscape = ruleIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" + path = path.replacingOccurrences(of: "{ruleId}", with: ruleIdPostEscape, options: .literal, range: nil) + let URLString = PureCloudPlatformClientV2API.basePath + path + let body: Data? = nil + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "GET", url: requestUrl!, body: body) + } + + /** + Retrieve the list of masking rules. + + - parameter completion: completion handler to receive the data and the error objects + */ + open class func getDataprivacyMaskingrules(completion: @escaping ((_ data: MaskingRuleListing?,_ error: Error?) -> Void)) { + let requestBuilder = getDataprivacyMaskingrulesWithRequestBuilder() + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Retrieve the list of masking rules. + - GET /api/v2/dataprivacy/maskingrules + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "entities" : [ { + "substituteCharacter" : "substituteCharacter", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "name" : "name", + "description" : "description", + "definition" : "definition", + "dateModified" : "2000-01-23T04:56:07.000+00:00", + "id" : "id", + "type" : "Custom", + "integrations" : [ "integrations", "integrations" ], + "enabled" : true + }, { + "substituteCharacter" : "substituteCharacter", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "name" : "name", + "description" : "description", + "definition" : "definition", + "dateModified" : "2000-01-23T04:56:07.000+00:00", + "id" : "id", + "type" : "Custom", + "integrations" : [ "integrations", "integrations" ], + "enabled" : true + } ] +}, statusCode=200}] + + - returns: RequestBuilder + */ + open class func getDataprivacyMaskingrulesWithRequestBuilder() -> RequestBuilder { + let path = "/api/v2/dataprivacy/maskingrules" + let URLString = PureCloudPlatformClientV2API.basePath + path + let body: Data? = nil + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "GET", url: requestUrl!, body: body) + } + + + + + + /** + Update information about a masking rule. + + - parameter ruleId: (path) ruleId + - parameter body: (body) (optional) + - parameter completion: completion handler to receive the data and the error objects + */ + open class func patchDataprivacyMaskingrule(ruleId: String, body: MaskingRule? = nil, completion: @escaping ((_ data: MaskingRule?,_ error: Error?) -> Void)) { + let requestBuilder = patchDataprivacyMaskingruleWithRequestBuilder(ruleId: ruleId, body: body) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Update information about a masking rule. + - PATCH /api/v2/dataprivacy/maskingrules/{ruleId} + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "substituteCharacter" : "substituteCharacter", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "name" : "name", + "description" : "description", + "definition" : "definition", + "dateModified" : "2000-01-23T04:56:07.000+00:00", + "id" : "id", + "type" : "Custom", + "integrations" : [ "integrations", "integrations" ], + "enabled" : true +}, statusCode=200}] + + - parameter ruleId: (path) ruleId + - parameter body: (body) (optional) + + - returns: RequestBuilder + */ + open class func patchDataprivacyMaskingruleWithRequestBuilder(ruleId: String, body: MaskingRule? = nil) -> RequestBuilder { + var path = "/api/v2/dataprivacy/maskingrules/{ruleId}" + let ruleIdPreEscape = "\(ruleId)" + let ruleIdPostEscape = ruleIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" + path = path.replacingOccurrences(of: "{ruleId}", with: ruleIdPostEscape, options: .literal, range: nil) + let URLString = PureCloudPlatformClientV2API.basePath + path + let body = JSONEncodingHelper.encodingParameters(forEncodableObject: body) + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "PATCH", url: requestUrl!, body: body) + } + + + + /** + Create a new masking rule resource. + + - parameter body: (body) Details for creating masking rule resource + - parameter completion: completion handler to receive the data and the error objects + */ + open class func postDataprivacyMaskingrules(body: MaskingRule, completion: @escaping ((_ data: MaskingRule?,_ error: Error?) -> Void)) { + let requestBuilder = postDataprivacyMaskingrulesWithRequestBuilder(body: body) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Create a new masking rule resource. + - POST /api/v2/dataprivacy/maskingrules + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "substituteCharacter" : "substituteCharacter", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "name" : "name", + "description" : "description", + "definition" : "definition", + "dateModified" : "2000-01-23T04:56:07.000+00:00", + "id" : "id", + "type" : "Custom", + "integrations" : [ "integrations", "integrations" ], + "enabled" : true +}, statusCode=200}] + + - parameter body: (body) Details for creating masking rule resource + + - returns: RequestBuilder + */ + open class func postDataprivacyMaskingrulesWithRequestBuilder(body: MaskingRule) -> RequestBuilder { + let path = "/api/v2/dataprivacy/maskingrules" + let URLString = PureCloudPlatformClientV2API.basePath + path + let body = JSONEncodingHelper.encodingParameters(forEncodableObject: body) + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "POST", url: requestUrl!, body: body) + } + + + + /** + Validate masking before creating. + + - parameter body: (body) Text to be masked + - parameter completion: completion handler to receive the data and the error objects + */ + open class func postDataprivacyMaskingrulesValidate(body: MaskingRuleValidateRequest, completion: @escaping ((_ data: MaskingRuleValidateResponse?,_ error: Error?) -> Void)) { + let requestBuilder = postDataprivacyMaskingrulesValidateWithRequestBuilder(body: body) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Validate masking before creating. + - POST /api/v2/dataprivacy/maskingrules/validate + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "valid" : true, + "validationMessage" : "validationMessage", + "maskedText" : "maskedText" +}, statusCode=200}] + + - parameter body: (body) Text to be masked + + - returns: RequestBuilder + */ + open class func postDataprivacyMaskingrulesValidateWithRequestBuilder(body: MaskingRuleValidateRequest) -> RequestBuilder { + let path = "/api/v2/dataprivacy/maskingrules/validate" + let URLString = PureCloudPlatformClientV2API.basePath + path + let body = JSONEncodingHelper.encodingParameters(forEncodableObject: body) + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "POST", url: requestUrl!, body: body) + } + +} diff --git a/build/src/APIs/ExternalContactsAPI.swift b/build/src/APIs/ExternalContactsAPI.swift index 1d70ca865..11e34c564 100644 --- a/build/src/APIs/ExternalContactsAPI.swift +++ b/build/src/APIs/ExternalContactsAPI.swift @@ -265,6 +265,51 @@ open class ExternalContactsAPI { + /** + Delete Settings + + - parameter settingsId: (path) Settings id + - parameter completion: completion handler to receive the data and the error objects + */ + open class func deleteExternalcontactsImportSetting(settingsId: String, completion: @escaping ((_ data: Void?,_ error: Error?) -> Void)) { + let requestBuilder = deleteExternalcontactsImportSettingWithRequestBuilder(settingsId: settingsId) + requestBuilder.execute { (response: Response?, error) -> Void in + if error == nil { + completion((), error) + } else { + completion(nil, error) + } + } + } + + /** + Delete Settings + - DELETE /api/v2/externalcontacts/import/settings/{settingsId} + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + + - parameter settingsId: (path) Settings id + + - returns: RequestBuilder + */ + open class func deleteExternalcontactsImportSettingWithRequestBuilder(settingsId: String) -> RequestBuilder { + var path = "/api/v2/externalcontacts/import/settings/{settingsId}" + let settingsIdPreEscape = "\(settingsId)" + let settingsIdPostEscape = settingsIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" + path = path.replacingOccurrences(of: "{settingsId}", with: settingsIdPostEscape, options: .literal, range: nil) + let URLString = PureCloudPlatformClientV2API.basePath + path + let body: Data? = nil + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "DELETE", url: requestUrl!, body: body) + } + + + /** Delete an external organization @@ -752,9 +797,9 @@ open class ExternalContactsAPI { - parameter contactId: (path) ExternalContact ID - parameter completion: completion handler to receive the data and the error objects */ - open class func getExternalcontactsContactIdentifiers(contactId: String, completion: @escaping ((_ data: EntityListing?,_ error: Error?) -> Void)) { + open class func getExternalcontactsContactIdentifiers(contactId: String, completion: @escaping ((_ data: ContactIdentifierListing?,_ error: Error?) -> Void)) { let requestBuilder = getExternalcontactsContactIdentifiersWithRequestBuilder(contactId: contactId) - requestBuilder.execute { (response: Response?, error) -> Void in + requestBuilder.execute { (response: Response?, error) -> Void in do { if let e = error { completion(nil, e) @@ -777,14 +822,26 @@ open class ExternalContactsAPI { - type: oauth2 - name: PureCloud OAuth - examples: [{contentType=application/json, example={ - "entities" : [ "{}", "{}" ] + "entities" : [ { + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "id" : "id", + "type" : "SocialLine", + "value" : "value" + }, { + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "id" : "id", + "type" : "SocialLine", + "value" : "value" + } ] }, statusCode=200}] - parameter contactId: (path) ExternalContact ID - - returns: RequestBuilder + - returns: RequestBuilder */ - open class func getExternalcontactsContactIdentifiersWithRequestBuilder(contactId: String) -> RequestBuilder { + open class func getExternalcontactsContactIdentifiersWithRequestBuilder(contactId: String) -> RequestBuilder { var path = "/api/v2/externalcontacts/contacts/{contactId}/identifiers" let contactIdPreEscape = "\(contactId)" let contactIdPostEscape = contactIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" @@ -794,7 +851,7 @@ open class ExternalContactsAPI { let requestUrl = URLComponents(string: URLString) - let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() return requestBuilder.init(method: "GET", url: requestUrl!, body: body) } @@ -2705,6 +2762,377 @@ open class ExternalContactsAPI { + /** + Get job based on id + + - parameter jobId: (path) Job id + - parameter completion: completion handler to receive the data and the error objects + */ + open class func getExternalcontactsImportJob(jobId: String, completion: @escaping ((_ data: ContactImportJobResponse?,_ error: Error?) -> Void)) { + let requestBuilder = getExternalcontactsImportJobWithRequestBuilder(jobId: jobId) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Get job based on id + - GET /api/v2/externalcontacts/import/jobs/{jobId} + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "executionStep" : "Validating", + "settings" : "{}", + "metadata" : "{}", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "statusDetails" : "statusDetails", + "id" : "id", + "status" : "Created" +}, statusCode=200}] + + - parameter jobId: (path) Job id + + - returns: RequestBuilder + */ + open class func getExternalcontactsImportJobWithRequestBuilder(jobId: String) -> RequestBuilder { + var path = "/api/v2/externalcontacts/import/jobs/{jobId}" + let jobIdPreEscape = "\(jobId)" + let jobIdPostEscape = jobIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" + path = path.replacingOccurrences(of: "{jobId}", with: jobIdPostEscape, options: .literal, range: nil) + let URLString = PureCloudPlatformClientV2API.basePath + path + let body: Data? = nil + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "GET", url: requestUrl!, body: body) + } + + + + + + + public enum SortOrder_getExternalcontactsImportJobs: String { + case ascending = "Ascending" + case descending = "Descending" + } + + + + public enum JobStatus_getExternalcontactsImportJobs: String { + case created = "Created" + case running = "Running" + case completed = "Completed" + case failed = "Failed" + case cancelled = "Cancelled" + } + + + /** + List jobs for organization + + - parameter after: (query) The cursor that points to the end of the set of entities that has been returned. (optional) + - parameter pageSize: (query) Number of entities to return. Maximum of 100. (optional) + - parameter sortOrder: (query) Direction of sorting. (optional) + - parameter jobStatus: (query) Search term to filter by jobStatus (optional) + - parameter completion: completion handler to receive the data and the error objects + */ + open class func getExternalcontactsImportJobs(after: String? = nil, pageSize: String? = nil, sortOrder: SortOrder_getExternalcontactsImportJobs? = nil, jobStatus: JobStatus_getExternalcontactsImportJobs? = nil, completion: @escaping ((_ data: ContactImportJobEntityListing?,_ error: Error?) -> Void)) { + let requestBuilder = getExternalcontactsImportJobsWithRequestBuilder(after: after, pageSize: pageSize, sortOrder: sortOrder, jobStatus: jobStatus) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + List jobs for organization + - GET /api/v2/externalcontacts/import/jobs + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "cursors" : "{}", + "entities" : [ { + "executionStep" : "Validating", + "settings" : "{}", + "metadata" : "{}", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "statusDetails" : "statusDetails", + "id" : "id", + "status" : "Created" + }, { + "executionStep" : "Validating", + "settings" : "{}", + "metadata" : "{}", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "statusDetails" : "statusDetails", + "id" : "id", + "status" : "Created" + } ], + "selfUri" : "selfUri", + "nextUri" : "nextUri", + "previousUri" : "previousUri" +}, statusCode=200}] + + - parameter after: (query) The cursor that points to the end of the set of entities that has been returned. (optional) + - parameter pageSize: (query) Number of entities to return. Maximum of 100. (optional) + - parameter sortOrder: (query) Direction of sorting. (optional) + - parameter jobStatus: (query) Search term to filter by jobStatus (optional) + + - returns: RequestBuilder + */ + open class func getExternalcontactsImportJobsWithRequestBuilder(after: String? = nil, pageSize: String? = nil, sortOrder: SortOrder_getExternalcontactsImportJobs? = nil, jobStatus: JobStatus_getExternalcontactsImportJobs? = nil) -> RequestBuilder { + let path = "/api/v2/externalcontacts/import/jobs" + let URLString = PureCloudPlatformClientV2API.basePath + path + let body: Data? = nil + + var requestUrl = URLComponents(string: URLString) + requestUrl?.queryItems = APIHelper.mapValuesToQueryItems([ + "after": after, + "pageSize": pageSize, + "sortOrder": sortOrder?.rawValue, + "jobStatus": jobStatus?.rawValue + ]) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "GET", url: requestUrl!, body: body) + } + + + + /** + Get setting based on id + + - parameter settingsId: (path) Settings id + - parameter completion: completion handler to receive the data and the error objects + */ + open class func getExternalcontactsImportSetting(settingsId: String, completion: @escaping ((_ data: ContactImportSettings?,_ error: Error?) -> Void)) { + let requestBuilder = getExternalcontactsImportSettingWithRequestBuilder(settingsId: settingsId) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Get setting based on id + - GET /api/v2/externalcontacts/import/settings/{settingsId} + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "mergeContacts" : true, + "matchingCriteria" : [ "Email", "Email" ], + "importFields" : [ { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + } ], + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "name" : "name", + "externalSourceId" : "externalSourceId", + "id" : "id" +}, statusCode=200}] + + - parameter settingsId: (path) Settings id + + - returns: RequestBuilder + */ + open class func getExternalcontactsImportSettingWithRequestBuilder(settingsId: String) -> RequestBuilder { + var path = "/api/v2/externalcontacts/import/settings/{settingsId}" + let settingsIdPreEscape = "\(settingsId)" + let settingsIdPostEscape = settingsIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" + path = path.replacingOccurrences(of: "{settingsId}", with: settingsIdPostEscape, options: .literal, range: nil) + let URLString = PureCloudPlatformClientV2API.basePath + path + let body: Data? = nil + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "GET", url: requestUrl!, body: body) + } + + + + + + + public enum SortOrder_getExternalcontactsImportSettings: String { + case ascending = "Ascending" + case descending = "Descending" + } + + + + + /** + List settings for organization + + - parameter after: (query) The cursor that points to the end of the set of entities that has been returned. (optional) + - parameter pageSize: (query) Number of entities to return. Maximum of 100. (optional) + - parameter sortOrder: (query) Direction of sorting. (optional) + - parameter name: (query) Search term to filter by settings name (optional) + - parameter completion: completion handler to receive the data and the error objects + */ + open class func getExternalcontactsImportSettings(after: String? = nil, pageSize: String? = nil, sortOrder: SortOrder_getExternalcontactsImportSettings? = nil, name: String? = nil, completion: @escaping ((_ data: ContactImportSettingsEntityListing?,_ error: Error?) -> Void)) { + let requestBuilder = getExternalcontactsImportSettingsWithRequestBuilder(after: after, pageSize: pageSize, sortOrder: sortOrder, name: name) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + List settings for organization + - GET /api/v2/externalcontacts/import/settings + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "cursors" : "{}", + "entities" : [ { + "mergeContacts" : true, + "matchingCriteria" : [ "Email", "Email" ], + "importFields" : [ { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + } ], + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "name" : "name", + "externalSourceId" : "externalSourceId", + "id" : "id" + }, { + "mergeContacts" : true, + "matchingCriteria" : [ "Email", "Email" ], + "importFields" : [ { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + } ], + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "name" : "name", + "externalSourceId" : "externalSourceId", + "id" : "id" + } ], + "selfUri" : "selfUri", + "nextUri" : "nextUri", + "previousUri" : "previousUri" +}, statusCode=200}] + + - parameter after: (query) The cursor that points to the end of the set of entities that has been returned. (optional) + - parameter pageSize: (query) Number of entities to return. Maximum of 100. (optional) + - parameter sortOrder: (query) Direction of sorting. (optional) + - parameter name: (query) Search term to filter by settings name (optional) + + - returns: RequestBuilder + */ + open class func getExternalcontactsImportSettingsWithRequestBuilder(after: String? = nil, pageSize: String? = nil, sortOrder: SortOrder_getExternalcontactsImportSettings? = nil, name: String? = nil) -> RequestBuilder { + let path = "/api/v2/externalcontacts/import/settings" + let URLString = PureCloudPlatformClientV2API.basePath + path + let body: Data? = nil + + var requestUrl = URLComponents(string: URLString) + requestUrl?.queryItems = APIHelper.mapValuesToQueryItems([ + "after": after, + "pageSize": pageSize, + "sortOrder": sortOrder?.rawValue, + "name": name + ]) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "GET", url: requestUrl!, body: body) + } + + + public enum Expand_getExternalcontactsOrganization: String { @@ -12113,6 +12541,139 @@ open class ExternalContactsAPI { + /** + Create a new job + + - parameter body: (body) Job + - parameter completion: completion handler to receive the data and the error objects + */ + open class func postExternalcontactsImportJobs(body: ContactImportJobRequest, completion: @escaping ((_ data: ContactImportJobResponse?,_ error: Error?) -> Void)) { + let requestBuilder = postExternalcontactsImportJobsWithRequestBuilder(body: body) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Create a new job + - POST /api/v2/externalcontacts/import/jobs + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "executionStep" : "Validating", + "settings" : "{}", + "metadata" : "{}", + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "statusDetails" : "statusDetails", + "id" : "id", + "status" : "Created" +}, statusCode=200}] + + - parameter body: (body) Job + + - returns: RequestBuilder + */ + open class func postExternalcontactsImportJobsWithRequestBuilder(body: ContactImportJobRequest) -> RequestBuilder { + let path = "/api/v2/externalcontacts/import/jobs" + let URLString = PureCloudPlatformClientV2API.basePath + path + let body = JSONEncodingHelper.encodingParameters(forEncodableObject: body) + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "POST", url: requestUrl!, body: body) + } + + + + /** + Create a new settings + + - parameter body: (body) Setting + - parameter completion: completion handler to receive the data and the error objects + */ + open class func postExternalcontactsImportSettings(body: ContactImportSettings, completion: @escaping ((_ data: ContactImportSettings?,_ error: Error?) -> Void)) { + let requestBuilder = postExternalcontactsImportSettingsWithRequestBuilder(body: body) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Create a new settings + - POST /api/v2/externalcontacts/import/settings + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "mergeContacts" : true, + "matchingCriteria" : [ "Email", "Email" ], + "importFields" : [ { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + } ], + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "name" : "name", + "externalSourceId" : "externalSourceId", + "id" : "id" +}, statusCode=200}] + + - parameter body: (body) Setting + + - returns: RequestBuilder + */ + open class func postExternalcontactsImportSettingsWithRequestBuilder(body: ContactImportSettings) -> RequestBuilder { + let path = "/api/v2/externalcontacts/import/settings" + let URLString = PureCloudPlatformClientV2API.basePath + path + let body = JSONEncodingHelper.encodingParameters(forEncodableObject: body) + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "POST", url: requestUrl!, body: body) + } + + + /** Merge two contacts into a new contact record @@ -13283,6 +13844,147 @@ open class ExternalContactsAPI { + /** + Update Job's workflow status + + - parameter jobId: (path) Job id + - parameter body: (body) Status of the Job's workflow + - parameter completion: completion handler to receive the data and the error objects + */ + open class func putExternalcontactsImportJob(jobId: String, body: ContactImportJobStatusUpdateRequest, completion: @escaping ((_ data: ContactImportJobStatusUpdateResponse?,_ error: Error?) -> Void)) { + let requestBuilder = putExternalcontactsImportJobWithRequestBuilder(jobId: jobId, body: body) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Update Job's workflow status + - PUT /api/v2/externalcontacts/import/jobs/{jobId} + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "jobId" : "jobId", + "status" : "Continue" +}, statusCode=200}] + + - parameter jobId: (path) Job id + - parameter body: (body) Status of the Job's workflow + + - returns: RequestBuilder + */ + open class func putExternalcontactsImportJobWithRequestBuilder(jobId: String, body: ContactImportJobStatusUpdateRequest) -> RequestBuilder { + var path = "/api/v2/externalcontacts/import/jobs/{jobId}" + let jobIdPreEscape = "\(jobId)" + let jobIdPostEscape = jobIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" + path = path.replacingOccurrences(of: "{jobId}", with: jobIdPostEscape, options: .literal, range: nil) + let URLString = PureCloudPlatformClientV2API.basePath + path + let body = JSONEncodingHelper.encodingParameters(forEncodableObject: body) + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "PUT", url: requestUrl!, body: body) + } + + + + + + /** + Update settings + + - parameter settingsId: (path) Settings id + - parameter body: (body) Setting + - parameter completion: completion handler to receive the data and the error objects + */ + open class func putExternalcontactsImportSetting(settingsId: String, body: ContactImportSettings, completion: @escaping ((_ data: ContactImportSettings?,_ error: Error?) -> Void)) { + let requestBuilder = putExternalcontactsImportSettingWithRequestBuilder(settingsId: settingsId, body: body) + requestBuilder.execute { (response: Response?, error) -> Void in + do { + if let e = error { + completion(nil, e) + } else if let r = response { + try requestBuilder.decode(r) + completion(response?.body, error) + } else { + completion(nil, error) + } + } catch { + completion(nil, error) + } + } + } + + /** + Update settings + - PUT /api/v2/externalcontacts/import/settings/{settingsId} + - OAuth: + - type: oauth2 + - name: PureCloud OAuth + - examples: [{contentType=application/json, example={ + "mergeContacts" : true, + "matchingCriteria" : [ "Email", "Email" ], + "importFields" : [ { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + }, { + "name" : "name", + "included" : true + } ], + "dateCreated" : "2000-01-23T04:56:07.000+00:00", + "selfUri" : "https://openapi-generator.tech", + "name" : "name", + "externalSourceId" : "externalSourceId", + "id" : "id" +}, statusCode=200}] + + - parameter settingsId: (path) Settings id + - parameter body: (body) Setting + + - returns: RequestBuilder + */ + open class func putExternalcontactsImportSettingWithRequestBuilder(settingsId: String, body: ContactImportSettings) -> RequestBuilder { + var path = "/api/v2/externalcontacts/import/settings/{settingsId}" + let settingsIdPreEscape = "\(settingsId)" + let settingsIdPostEscape = settingsIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" + path = path.replacingOccurrences(of: "{settingsId}", with: settingsIdPostEscape, options: .literal, range: nil) + let URLString = PureCloudPlatformClientV2API.basePath + path + let body = JSONEncodingHelper.encodingParameters(forEncodableObject: body) + + let requestUrl = URLComponents(string: URLString) + + let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() + + return requestBuilder.init(method: "PUT", url: requestUrl!, body: body) + } + + + + + /** Update an external organization diff --git a/build/src/APIs/JourneyAPI.swift b/build/src/APIs/JourneyAPI.swift index b60d2b5af..94fffe4c8 100644 --- a/build/src/APIs/JourneyAPI.swift +++ b/build/src/APIs/JourneyAPI.swift @@ -317,7 +317,6 @@ open class JourneyAPI { /** Delete the Schedule of a JourneyView - DELETE /api/v2/journey/views/{viewId}/schedules - - used for long descriptions - OAuth: - type: oauth2 - name: PureCloud OAuth @@ -2509,7 +2508,6 @@ open class JourneyAPI { /** Get the Schedule for a JourneyView - GET /api/v2/journey/views/{viewId}/schedules - - used for long descriptions - OAuth: - type: oauth2 - name: PureCloud OAuth @@ -2933,7 +2931,6 @@ open class JourneyAPI { /** Get the job for a journey view version. - GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} - - used for long descriptions - OAuth: - type: oauth2 - name: PureCloud OAuth @@ -3008,7 +3005,6 @@ open class JourneyAPI { /** Get the result of a job for a journey view version. - GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results - - used for long descriptions - OAuth: - type: oauth2 - name: PureCloud OAuth @@ -3222,7 +3218,6 @@ open class JourneyAPI { /** Get the latest job of a journey view version. - GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest - - used for long descriptions - OAuth: - type: oauth2 - name: PureCloud OAuth @@ -4297,7 +4292,6 @@ open class JourneyAPI { /** Update the job for a journey view version. Only the status can be changed and only to Cancelled - PATCH /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} - - used for long descriptions - OAuth: - type: oauth2 - name: PureCloud OAuth @@ -5486,7 +5480,6 @@ open class JourneyAPI { /** Submit a job request for a journey view version. - POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs - - used for long descriptions - OAuth: - type: oauth2 - name: PureCloud OAuth @@ -5923,7 +5916,6 @@ open class JourneyAPI { /** Update the Schedule for a JourneyView - PUT /api/v2/journey/views/{viewId}/schedules - - used for long descriptions - OAuth: - type: oauth2 - name: PureCloud OAuth diff --git a/build/src/APIs/LearningAPI.swift b/build/src/APIs/LearningAPI.swift index 1e40de09b..68e8ba749 100644 --- a/build/src/APIs/LearningAPI.swift +++ b/build/src/APIs/LearningAPI.swift @@ -472,9 +472,9 @@ open class LearningAPI { - type: oauth2 - name: PureCloud OAuth - examples: [{contentType=application/json, example={ - "total" : 1, - "pageCount" : 5, - "pageNumber" : 6, + "total" : 4, + "pageCount" : 7, + "pageNumber" : 2, "entities" : [ { "dateRecommendedForCompletion" : "2000-01-23T04:56:07.000+00:00", "assessmentCompletionPercentage" : 1.4658129, @@ -623,7 +623,7 @@ open class LearningAPI { "firstUri" : "https://openapi-generator.tech", "lastUri" : "https://openapi-generator.tech", "selfUri" : "https://openapi-generator.tech", - "pageSize" : 0, + "pageSize" : 3, "nextUri" : "https://openapi-generator.tech", "previousUri" : "https://openapi-generator.tech" }, statusCode=200}] @@ -789,9 +789,9 @@ open class LearningAPI { - type: oauth2 - name: PureCloud OAuth - examples: [{contentType=application/json, example={ - "total" : 1, - "pageCount" : 5, - "pageNumber" : 6, + "total" : 4, + "pageCount" : 7, + "pageNumber" : 2, "entities" : [ { "dateRecommendedForCompletion" : "2000-01-23T04:56:07.000+00:00", "assessmentCompletionPercentage" : 1.4658129, @@ -940,7 +940,7 @@ open class LearningAPI { "firstUri" : "https://openapi-generator.tech", "lastUri" : "https://openapi-generator.tech", "selfUri" : "https://openapi-generator.tech", - "pageSize" : 0, + "pageSize" : 3, "nextUri" : "https://openapi-generator.tech", "previousUri" : "https://openapi-generator.tech" }, statusCode=200}] @@ -1512,9 +1512,9 @@ open class LearningAPI { - type: oauth2 - name: PureCloud OAuth - examples: [{contentType=application/json, example={ - "total" : 7, - "pageCount" : 9, - "pageNumber" : 2, + "total" : 1, + "pageCount" : 5, + "pageNumber" : 6, "entities" : [ { "reassignSummaryData" : "{}", "archivalMode" : "Graceful", @@ -1609,7 +1609,7 @@ open class LearningAPI { "firstUri" : "https://openapi-generator.tech", "lastUri" : "https://openapi-generator.tech", "selfUri" : "https://openapi-generator.tech", - "pageSize" : 5, + "pageSize" : 0, "nextUri" : "https://openapi-generator.tech", "previousUri" : "https://openapi-generator.tech" }, statusCode=200}] diff --git a/build/src/APIs/OutboundAPI.swift b/build/src/APIs/OutboundAPI.swift index 8173c6573..f3c058d89 100644 --- a/build/src/APIs/OutboundAPI.swift +++ b/build/src/APIs/OutboundAPI.swift @@ -137486,13 +137486,13 @@ open class OutboundAPI { - type: oauth2 - name: PureCloud OAuth - examples: [{contentType=application/json, example={ - "completedRecords" : 1, - "totalRecords" : 6, + "completedRecords" : 6, + "totalRecords" : 0, "failureReason" : "{}", "selfUri" : "https://openapi-generator.tech", "id" : "id", "state" : "InProgress", - "percentComplete" : 5, + "percentComplete" : 1, "downloadURI" : "downloadURI", "type" : "BulkDelete" }, statusCode=200}] @@ -137555,23 +137555,23 @@ open class OutboundAPI { - examples: [{contentType=application/json, example={ "total" : 0, "entities" : [ { - "completedRecords" : 1, - "totalRecords" : 6, + "completedRecords" : 6, + "totalRecords" : 0, "failureReason" : "{}", "selfUri" : "https://openapi-generator.tech", "id" : "id", "state" : "InProgress", - "percentComplete" : 5, + "percentComplete" : 1, "downloadURI" : "downloadURI", "type" : "BulkDelete" }, { - "completedRecords" : 1, - "totalRecords" : 6, + "completedRecords" : 6, + "totalRecords" : 0, "failureReason" : "{}", "selfUri" : "https://openapi-generator.tech", "id" : "id", "state" : "InProgress", - "percentComplete" : 5, + "percentComplete" : 1, "downloadURI" : "downloadURI", "type" : "BulkDelete" } ], @@ -144462,13 +144462,13 @@ open class OutboundAPI { - type: oauth2 - name: PureCloud OAuth - examples: [{contentType=application/json, example={ - "completedRecords" : 1, - "totalRecords" : 6, + "completedRecords" : 6, + "totalRecords" : 0, "failureReason" : "{}", "selfUri" : "https://openapi-generator.tech", "id" : "id", "state" : "InProgress", - "percentComplete" : 5, + "percentComplete" : 1, "downloadURI" : "downloadURI", "type" : "BulkDelete" }, statusCode=200}] @@ -144529,13 +144529,13 @@ open class OutboundAPI { - type: oauth2 - name: PureCloud OAuth - examples: [{contentType=application/json, example={ - "completedRecords" : 1, - "totalRecords" : 6, + "completedRecords" : 6, + "totalRecords" : 0, "failureReason" : "{}", "selfUri" : "https://openapi-generator.tech", "id" : "id", "state" : "InProgress", - "percentComplete" : 5, + "percentComplete" : 1, "downloadURI" : "downloadURI", "type" : "BulkDelete" }, statusCode=200}] diff --git a/build/src/APIs/RecordingAPI.swift b/build/src/APIs/RecordingAPI.swift index 1c1d2f399..a399d6ce0 100644 --- a/build/src/APIs/RecordingAPI.swift +++ b/build/src/APIs/RecordingAPI.swift @@ -8020,19 +8020,13 @@ open class RecordingAPI { "expectedResultCount" : 0, "results" : [ { "conversationId" : "conversationId", - "selfUri" : "https://openapi-generator.tech", - "name" : "name", "resultUrl" : "resultUrl", - "id" : "id", "recordingId" : "recordingId", "contentType" : "contentType", "errorMsg" : "errorMsg" }, { "conversationId" : "conversationId", - "selfUri" : "https://openapi-generator.tech", - "name" : "name", "resultUrl" : "resultUrl", - "id" : "id", "recordingId" : "recordingId", "contentType" : "contentType", "errorMsg" : "errorMsg" diff --git a/build/src/APIs/TaskManagementAPI.swift b/build/src/APIs/TaskManagementAPI.swift index 140257716..c7f65f87d 100644 --- a/build/src/APIs/TaskManagementAPI.swift +++ b/build/src/APIs/TaskManagementAPI.swift @@ -1239,6 +1239,7 @@ open class TaskManagementAPI { case defaultlanguage = "defaultLanguage" case schema = "schema" case flow = "flow" + case defaultscript = "defaultScript" } /** diff --git a/build/src/APIs/TelephonyProvidersEdgeAPI.swift b/build/src/APIs/TelephonyProvidersEdgeAPI.swift index 553ba6105..efb380422 100644 --- a/build/src/APIs/TelephonyProvidersEdgeAPI.swift +++ b/build/src/APIs/TelephonyProvidersEdgeAPI.swift @@ -14705,11 +14705,13 @@ open class TelephonyProvidersEdgeAPI { "pageNumber" : 1, "entities" : [ { "offset" : 0, + "canonicalId" : "canonicalId", "selfUri" : "https://openapi-generator.tech", "name" : "name", "id" : "id" }, { "offset" : 0, + "canonicalId" : "canonicalId", "selfUri" : "https://openapi-generator.tech", "name" : "name", "id" : "id" diff --git a/build/src/APIs/UtilitiesAPI.swift b/build/src/APIs/UtilitiesAPI.swift index 24a2ca480..a15422b20 100644 --- a/build/src/APIs/UtilitiesAPI.swift +++ b/build/src/APIs/UtilitiesAPI.swift @@ -153,11 +153,13 @@ open class UtilitiesAPI { "pageNumber" : 1, "entities" : [ { "offset" : 0, + "canonicalId" : "canonicalId", "selfUri" : "https://openapi-generator.tech", "name" : "name", "id" : "id" }, { "offset" : 0, + "canonicalId" : "canonicalId", "selfUri" : "https://openapi-generator.tech", "name" : "name", "id" : "id" diff --git a/build/src/APIs/WorkforceManagementAPI.swift b/build/src/APIs/WorkforceManagementAPI.swift index 785846029..44603a46f 100644 --- a/build/src/APIs/WorkforceManagementAPI.swift +++ b/build/src/APIs/WorkforceManagementAPI.swift @@ -7931,18 +7931,15 @@ open class WorkforceManagementAPI { - - /** Get a list of time off requests for a given user - parameter managementUnitId: (path) The ID of the management unit, or 'mine' for the management unit of the logged-in user. - parameter userId: (path) The userId to whom the Time Off Request applies. - - parameter recentlyReviewed: (query) Limit results to requests that have been reviewed within the preceding 30 days (optional) - parameter completion: completion handler to receive the data and the error objects */ - open class func getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId: String, userId: String, recentlyReviewed: Bool? = nil, completion: @escaping ((_ data: TimeOffRequestList?,_ error: Error?) -> Void)) { - let requestBuilder = getWorkforcemanagementManagementunitUserTimeoffrequestsWithRequestBuilder(managementUnitId: managementUnitId, userId: userId, recentlyReviewed: recentlyReviewed) + open class func getWorkforcemanagementManagementunitUserTimeoffrequests(managementUnitId: String, userId: String, completion: @escaping ((_ data: TimeOffRequestList?,_ error: Error?) -> Void)) { + let requestBuilder = getWorkforcemanagementManagementunitUserTimeoffrequestsWithRequestBuilder(managementUnitId: managementUnitId, userId: userId) requestBuilder.execute { (response: Response?, error) -> Void in do { if let e = error { @@ -8022,11 +8019,10 @@ open class WorkforceManagementAPI { - parameter managementUnitId: (path) The ID of the management unit, or 'mine' for the management unit of the logged-in user. - parameter userId: (path) The userId to whom the Time Off Request applies. - - parameter recentlyReviewed: (query) Limit results to requests that have been reviewed within the preceding 30 days (optional) - returns: RequestBuilder */ - open class func getWorkforcemanagementManagementunitUserTimeoffrequestsWithRequestBuilder(managementUnitId: String, userId: String, recentlyReviewed: Bool? = nil) -> RequestBuilder { + open class func getWorkforcemanagementManagementunitUserTimeoffrequestsWithRequestBuilder(managementUnitId: String, userId: String) -> RequestBuilder { var path = "/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests" let managementUnitIdPreEscape = "\(managementUnitId)" let managementUnitIdPostEscape = managementUnitIdPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? "" @@ -8037,10 +8033,7 @@ open class WorkforceManagementAPI { let URLString = PureCloudPlatformClientV2API.basePath + path let body: Data? = nil - var requestUrl = URLComponents(string: URLString) - requestUrl?.queryItems = APIHelper.mapValuesToQueryItems([ - "recentlyReviewed": recentlyReviewed - ]) + let requestUrl = URLComponents(string: URLString) let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() @@ -9926,16 +9919,13 @@ open class WorkforceManagementAPI { return requestBuilder.init(method: "GET", url: requestUrl!, body: body) } - - /** Get a list of time off requests for the current user - - parameter recentlyReviewed: (query) Limit results to requests that have been reviewed within the preceding 30 days (optional) - parameter completion: completion handler to receive the data and the error objects */ - open class func getWorkforcemanagementTimeoffrequests(recentlyReviewed: Bool? = nil, completion: @escaping ((_ data: TimeOffRequestList?,_ error: Error?) -> Void)) { - let requestBuilder = getWorkforcemanagementTimeoffrequestsWithRequestBuilder(recentlyReviewed: recentlyReviewed) + open class func getWorkforcemanagementTimeoffrequests(completion: @escaping ((_ data: TimeOffRequestList?,_ error: Error?) -> Void)) { + let requestBuilder = getWorkforcemanagementTimeoffrequestsWithRequestBuilder() requestBuilder.execute { (response: Response?, error) -> Void in do { if let e = error { @@ -10012,20 +10002,15 @@ open class WorkforceManagementAPI { "status" : "PENDING" } ] }, statusCode=200}] - - - parameter recentlyReviewed: (query) Limit results to requests that have been reviewed within the preceding 30 days (optional) - returns: RequestBuilder */ - open class func getWorkforcemanagementTimeoffrequestsWithRequestBuilder(recentlyReviewed: Bool? = nil) -> RequestBuilder { + open class func getWorkforcemanagementTimeoffrequestsWithRequestBuilder() -> RequestBuilder { let path = "/api/v2/workforcemanagement/timeoffrequests" let URLString = PureCloudPlatformClientV2API.basePath + path let body: Data? = nil - var requestUrl = URLComponents(string: URLString) - requestUrl?.queryItems = APIHelper.mapValuesToQueryItems([ - "recentlyReviewed": recentlyReviewed - ]) + let requestUrl = URLComponents(string: URLString) let requestBuilder: RequestBuilder.Type = PureCloudPlatformClientV2API.requestBuilderFactory.getBuilder() diff --git a/build/src/Models/PlatformAPIModelsP1.swift b/build/src/Models/PlatformAPIModelsP1.swift index cb231482b..a728fce04 100644 --- a/build/src/Models/PlatformAPIModelsP1.swift +++ b/build/src/Models/PlatformAPIModelsP1.swift @@ -33,23 +33,23 @@ public class AcceleratorList: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [AcceleratorMetadata]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [AcceleratorMetadata]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -312,23 +312,23 @@ public class ActionMapListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ActionMap]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ActionMap]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -910,23 +910,23 @@ public class AgentActivityEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [AgentActivity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [AgentActivity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -2808,7 +2808,7 @@ public class BatchDownloadJobStatusResult: Codable { public var resultCount: Int? /** Current number of error results. */ public var errorCount: Int? - /** Current status of the job. This could be either IN_PROGRESS or COMPLETED. A job is considered completed when all the submitted requests have been processed and fulfilled. */ + /** Current status of the job. A job is considered completed when all the submitted requests have been processed and fulfilled. */ public var status: Status? /** Current set of results for the job. */ public var results: [BatchDownloadJobResult]? @@ -3078,23 +3078,23 @@ public class BotConnectorBotSummaryEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [BotSummary]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [BotSummary]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -4998,23 +4998,23 @@ public class CallConversationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CallConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CallConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5519,23 +5519,23 @@ public class CampaignEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Campaign]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Campaign]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5874,23 +5874,23 @@ public class CampaignSequenceEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CampaignSequence]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CampaignSequence]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -6051,23 +6051,23 @@ public class CategoriesEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [StaCategory]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [StaCategory]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -6405,23 +6405,23 @@ public class CoachingAppointmentResponseList: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CoachingAppointmentResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CoachingAppointmentResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -6968,23 +6968,23 @@ public class CommonCampaignDivisionViewEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CommonCampaignDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CommonCampaignDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -7247,23 +7247,23 @@ public class ConsumedResourcesEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Dependency]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Dependency]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -7534,6 +7534,39 @@ public class ContactDetailEventTopicContactUpdateEvent: Codable { +public class ContactImportSettingsEntityListing: Codable { + + + + + + + + + + + + public var entities: [ContactImportSettings]? + public var nextUri: String? + public var selfUri: String? + public var previousUri: String? + /** The cursor that points to the next set of entities being returned. */ + public var cursors: Cursors? + + public init(entities: [ContactImportSettings]?, nextUri: String?, selfUri: String?, previousUri: String?, cursors: Cursors?) { + self.entities = entities + self.nextUri = nextUri + self.selfUri = selfUri + self.previousUri = previousUri + self.cursors = cursors + } + + +} + + + + public class ContactListFilter: Codable { @@ -8854,23 +8887,23 @@ public class ConversationCategoriesEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ConversationCategory]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ConversationCategory]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -9205,6 +9238,29 @@ public class ConversationCobrowseEventTopicQueueMediaSettings: Codable { +/** Metadata enrichments provided by the platform. */ + +public class ConversationEnrichment: Codable { + + + + + + /** Detected language of this message. */ + public var language: ConversationEnrichmentLanguage? + /** Detected sentiment of this message. */ + public var sentimentV2: ConversationEnrichmentSentimentV2? + + public init(language: ConversationEnrichmentLanguage?, sentimentV2: ConversationEnrichmentSentimentV2?) { + self.language = language + self.sentimentV2 = sentimentV2 + } + + +} + + + /** User reaction to public message. */ public class ConversationContentReaction: Codable { @@ -9832,29 +9888,6 @@ public class ConversationEmailEventTopicWrapup: Codable { -/** Metadata enrichments provided by the platform. */ - -public class ConversationEnrichment: Codable { - - - - - - /** Detected language of this message. */ - public var language: ConversationEnrichmentLanguage? - /** Detected sentiment of this message. */ - public var sentimentV2: ConversationEnrichmentSentimentV2? - - public init(language: ConversationEnrichmentLanguage?, sentimentV2: ConversationEnrichmentSentimentV2?) { - self.language = language - self.sentimentV2 = sentimentV2 - } - - -} - - - public class ConversationEntityListing: Codable { @@ -9882,23 +9915,23 @@ public class ConversationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Conversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Conversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12068,23 +12101,23 @@ public class CredentialTypeListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CredentialType]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CredentialType]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12542,23 +12575,23 @@ public class DashboardConfigurationListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DashboardConfiguration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DashboardConfiguration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12883,6 +12916,7 @@ public class DependencyObject: Codable { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -13532,23 +13566,6 @@ public class DialerOutboundSettingsConfigChangeOutboundSettings: Codable { - -public class Digits: Codable { - - - - /** A string representing the digits pressed on phone. */ - public var digits: String? - - public init(digits: String?) { - self.digits = digits - } - - -} - - - /** the schedule range */ public class DialerSequenceScheduleConfigChangeRecurrenceRange: Codable { @@ -13966,23 +13983,23 @@ public class DigitalRuleSetEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DigitalRuleSet]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DigitalRuleSet]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -13992,6 +14009,23 @@ public class DigitalRuleSetEntityListing: Codable { +public class Digits: Codable { + + + + /** A string representing the digits pressed on phone. */ + public var digits: String? + + public init(digits: String?) { + self.digits = digits + } + + +} + + + + public class DirectRouting: Codable { @@ -14196,23 +14230,23 @@ public class DncListDivisionViewListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DncListDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DncListDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -15061,23 +15095,23 @@ public class DomainEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DomainEntity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DomainEntity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -15549,6 +15583,33 @@ public class DomainOrganizationRoleUpdate: Codable { +public class DomainRole: Codable { + + + + + + /** The ID of the role */ + public var _id: String? + /** The name of the role */ + public var name: String? + + public init(_id: String?, name: String?) { + self._id = _id + self.name = name + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + } + + +} + + + + public class DomainPhysicalInterface: Codable { @@ -15671,33 +15732,6 @@ public class DomainPhysicalInterface: Codable { -public class DomainRole: Codable { - - - - - - /** The ID of the role */ - public var _id: String? - /** The name of the role */ - public var name: String? - - public init(_id: String?, name: String?) { - self._id = _id - self.name = name - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - } - - -} - - - - public class Draft: Codable { @@ -16454,24 +16488,24 @@ public class EmergencyGroupDivisionViewEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EmergencyGroupDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EmergencyGroupDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16507,23 +16541,23 @@ public class EmergencyGroupListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EmergencyGroup]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EmergencyGroup]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -17706,24 +17740,24 @@ public class ExtensionPoolDivisionViewEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ExtensionPoolDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ExtensionPoolDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18314,23 +18348,23 @@ public class FacebookIntegrationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FacebookIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FacebookIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18625,6 +18659,68 @@ public class FlowActivityQuery: Codable { +public class Format: Codable { + + + public enum Flags: String, Codable { + case boolPlayYesNo = "BoolPlayYesNo" + case currencyAsMinorUnits = "CurrencyAsMinorUnits" + case currencyMajorUnitsOnly = "CurrencyMajorUnitsOnly" + case currencyMinorUnitsOnly = "CurrencyMinorUnitsOnly" + case currencyPlayDigits = "CurrencyPlayDigits" + case dateLongYear = "DateLongYear" + case dateShortYear = "DateShortYear" + case dateShortMonthAndDay = "DateShortMonthAndDay" + case dateDayOfWeekOnly = "DateDayOfWeekOnly" + case dateDayOnly = "DateDayOnly" + case dateMonthOnly = "DateMonthOnly" + case dateShortYearOnly = "DateShortYearOnly" + case dateLongYearOnly = "DateLongYearOnly" + case timeTwentyFourHours = "TimeTwentyFourHours" + case timeTwelveHours = "TimeTwelveHours" + case timePartDays = "TimePartDays" + case timePartHours = "TimePartHours" + case timePartMinutes = "TimePartMinutes" + case timePartSeconds = "TimePartSeconds" + case stringPlayChars = "StringPlayChars" + case numberPlayDigits = "NumberPlayDigits" + case numberOrdinal = "NumberOrdinal" + case languageCaseArticle = "LanguageCaseArticle" + case languageCaseAccusative = "LanguageCaseAccusative" + case languageCaseDative = "LanguageCaseDative" + case languageCaseGenitive = "LanguageCaseGenitive" + case languageCaseNominative = "LanguageCaseNominative" + case languageQuantityPlural = "LanguageQuantityPlural" + case languageQuantitySingular = "LanguageQuantitySingular" + case languageGenderCommon = "LanguageGenderCommon" + case languageGenderFeminine = "LanguageGenderFeminine" + case languageGenderMasculine = "LanguageGenderMasculine" + case languageGenderNeuter = "LanguageGenderNeuter" + case caseArticle = "CaseArticle" + case caseAccusative = "CaseAccusative" + case caseDative = "CaseDative" + case caseGenitive = "CaseGenitive" + case caseNominative = "CaseNominative" + case quantityPlural = "QuantityPlural" + case quantitySingular = "QuantitySingular" + case genderCommon = "GenderCommon" + case genderFeminine = "GenderFeminine" + case genderMasculine = "GenderMasculine" + case genderNeuter = "GenderNeuter" + } + /** The Set of prompt segment format flags i.e. each entry is a part of describing the overall format. E.g. \"format\": { \"flags\": [StringPlayChars] } */ + public var flags: [Flags]? + + public init(flags: [Flags]?) { + self.flags = flags + } + + +} + + + + public class FlowActivityQueryClause: Codable { public enum ModelType: String, Codable { @@ -19113,23 +19209,23 @@ public class FlowMilestoneDivisionViewEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FlowMilestoneDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FlowMilestoneDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19165,23 +19261,23 @@ public class FlowMilestoneListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FlowMilestone]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FlowMilestone]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19392,23 +19488,23 @@ public class FlowVersionEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FlowVersion]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FlowVersion]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19435,68 +19531,6 @@ public class ForecastAbandonRateResponse: Codable { -public class Format: Codable { - - - public enum Flags: String, Codable { - case boolPlayYesNo = "BoolPlayYesNo" - case currencyAsMinorUnits = "CurrencyAsMinorUnits" - case currencyMajorUnitsOnly = "CurrencyMajorUnitsOnly" - case currencyMinorUnitsOnly = "CurrencyMinorUnitsOnly" - case currencyPlayDigits = "CurrencyPlayDigits" - case dateLongYear = "DateLongYear" - case dateShortYear = "DateShortYear" - case dateShortMonthAndDay = "DateShortMonthAndDay" - case dateDayOfWeekOnly = "DateDayOfWeekOnly" - case dateDayOnly = "DateDayOnly" - case dateMonthOnly = "DateMonthOnly" - case dateShortYearOnly = "DateShortYearOnly" - case dateLongYearOnly = "DateLongYearOnly" - case timeTwentyFourHours = "TimeTwentyFourHours" - case timeTwelveHours = "TimeTwelveHours" - case timePartDays = "TimePartDays" - case timePartHours = "TimePartHours" - case timePartMinutes = "TimePartMinutes" - case timePartSeconds = "TimePartSeconds" - case stringPlayChars = "StringPlayChars" - case numberPlayDigits = "NumberPlayDigits" - case numberOrdinal = "NumberOrdinal" - case languageCaseArticle = "LanguageCaseArticle" - case languageCaseAccusative = "LanguageCaseAccusative" - case languageCaseDative = "LanguageCaseDative" - case languageCaseGenitive = "LanguageCaseGenitive" - case languageCaseNominative = "LanguageCaseNominative" - case languageQuantityPlural = "LanguageQuantityPlural" - case languageQuantitySingular = "LanguageQuantitySingular" - case languageGenderCommon = "LanguageGenderCommon" - case languageGenderFeminine = "LanguageGenderFeminine" - case languageGenderMasculine = "LanguageGenderMasculine" - case languageGenderNeuter = "LanguageGenderNeuter" - case caseArticle = "CaseArticle" - case caseAccusative = "CaseAccusative" - case caseDative = "CaseDative" - case caseGenitive = "CaseGenitive" - case caseNominative = "CaseNominative" - case quantityPlural = "QuantityPlural" - case quantitySingular = "QuantitySingular" - case genderCommon = "GenderCommon" - case genderFeminine = "GenderFeminine" - case genderMasculine = "GenderMasculine" - case genderNeuter = "GenderNeuter" - } - /** The Set of prompt segment format flags i.e. each entry is a part of describing the overall format. E.g. \"format\": { \"flags\": [StringPlayChars] } */ - public var flags: [Flags]? - - public init(flags: [Flags]?) { - self.flags = flags - } - - -} - - - - public class FromEmailAddress: Codable { @@ -19830,23 +19864,23 @@ public class GroupEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Group]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Group]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -20142,23 +20176,23 @@ public class IdentityProviderEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [IdentityProvider]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [IdentityProvider]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -20385,23 +20419,23 @@ public class InstagramIntegrationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [InstagramIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [InstagramIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -21545,23 +21579,23 @@ public class JourneyViewJobListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [JourneyViewJob]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [JourneyViewJob]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -21765,23 +21799,23 @@ public class JourneyViewScheduleListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [JourneyViewSchedule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [JourneyViewSchedule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -23239,6 +23273,23 @@ public class KnowledgeImportJobReport: Codable { +public class KnowledgeIntegrationDefaultSettings: Codable { + + + + /** The default base URL setting for the integration. */ + public var baseUrl: String? + + public init(baseUrl: String?) { + self.baseUrl = baseUrl + } + + +} + + + + public class KnowledgeIntegrationFilterValue: Codable { @@ -23879,23 +23930,23 @@ public class LearningAssignmentsDomainEntity: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LearningAssignment]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LearningAssignment]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -24066,23 +24117,23 @@ public class LearningModulesDomainEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LearningModule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LearningModule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -24236,23 +24287,23 @@ public class LexBotAliasEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LexBotAlias]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LexBotAlias]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -24288,23 +24339,23 @@ public class LexBotEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LexBot]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LexBot]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -24357,23 +24408,23 @@ public class LibraryEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Library]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Library]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -24811,23 +24862,23 @@ public class LocationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LocationDefinition]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LocationDefinition]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -25131,27 +25182,27 @@ public class ManagementUnitListing: Codable { /** Deprecated, paging is not supported */ public var total: Int64? /** Deprecated, paging is not supported */ - public var nextUri: String? - /** Deprecated, paging is not supported */ - public var previousUri: String? + public var firstUri: String? /** Deprecated, paging is not supported */ public var lastUri: String? /** Deprecated, paging is not supported */ - public var firstUri: String? - /** Deprecated, paging is not supported */ public var pageCount: Int? + /** Deprecated, paging is not supported */ + public var nextUri: String? + /** Deprecated, paging is not supported */ + public var previousUri: String? public var selfUri: String? - public init(entities: [ManagementUnit]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, pageCount: Int?, selfUri: String?) { + public init(entities: [ManagementUnit]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, pageCount: Int?, nextUri: String?, previousUri: String?, selfUri: String?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.pageCount = pageCount + self.nextUri = nextUri + self.previousUri = previousUri self.selfUri = selfUri } @@ -25160,6 +25211,123 @@ public class ManagementUnitListing: Codable { + +public class MaskingRule: Codable { + + + + + + + + + + + + + + public enum ModelType: String, Codable { + case custom = "Custom" + case predefined = "Predefined" + case _default = "Default" + } + + + + + + + + /** The globally unique identifier for the object. */ + public var _id: String? + /** Masking rule name. */ + public var name: String? + /** Description about masking rule. */ + public var _description: String? + /** Replacement character for masked text character. */ + public var substituteCharacter: String? + /** Definition of masking rule (a valid regex or builtin AI based mask name). */ + public var definition: String? + /** True/False */ + public var enabled: Bool? + /** Masking rule type */ + public var type: ModelType? + /** Associated integration channels */ + public var integrations: [String]? + /** Date when the rule was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateCreated: Date? + /** Date when the rule was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateModified: Date? + + public init(_id: String?, name: String?, _description: String?, substituteCharacter: String?, definition: String?, enabled: Bool?, type: ModelType?, integrations: [String]?, dateCreated: Date?, dateModified: Date?) { + self._id = _id + self.name = name + self._description = _description + self.substituteCharacter = substituteCharacter + self.definition = definition + self.enabled = enabled + self.type = type + self.integrations = integrations + self.dateCreated = dateCreated + self.dateModified = dateModified + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case _description = "description" + case substituteCharacter + case definition + case enabled + case type + case integrations + case dateCreated + case dateModified + } + + +} + + + + +public class MaskingRuleListing: Codable { + + + + public var entities: [MaskingRule]? + + public init(entities: [MaskingRule]?) { + self.entities = entities + } + + +} + + + + +public class MaskingRuleValidateRequest: Codable { + + + + + + /** Text to mask. */ + public var text: String? + /** Regex to be applied */ + public var definition: String? + + public init(text: String?, definition: String?) { + self.text = text + self.definition = definition + } + + +} + + + /** Defines a simple matching condition */ public class MatchCriteria: Codable { @@ -27169,23 +27337,23 @@ public class NuanceBotEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [NuanceBot]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [NuanceBot]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -27896,23 +28064,23 @@ public class OrganizationPresenceEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [OrganizationPresence]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [OrganizationPresence]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -28113,6 +28281,93 @@ public class OutboundMessagingEmailCampaignProgressEventCampaignProgress: Codabl +public class Outcome: Codable { + + + + + + + + + + + + + + + + + + + + + + + + + + /** ID of the outcome. */ + public var _id: String? + /** Whether or not the outcome is active. */ + public var isActive: Bool? + /** The display name of the outcome. */ + public var displayName: String? + /** The version of the outcome. */ + public var version: Int? + /** A description of the outcome. */ + public var _description: String? + /** Whether or not the outcome is positive. */ + public var isPositive: Bool? + /** The context of the outcome. */ + public var context: Context? + /** The pattern of rules defining the filter of the outcome. */ + public var journey: Journey? + /** The field from the event indicating the associated value. */ + public var associatedValueField: AssociatedValueField? + /** The URI for this object */ + public var selfUri: String? + /** 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 */ + public var createdDate: Date? + /** 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 */ + public var modifiedDate: Date? + + public init(_id: String?, isActive: Bool?, displayName: String?, version: Int?, _description: String?, isPositive: Bool?, context: Context?, journey: Journey?, associatedValueField: AssociatedValueField?, selfUri: String?, createdDate: Date?, modifiedDate: Date?) { + self._id = _id + self.isActive = isActive + self.displayName = displayName + self.version = version + self._description = _description + self.isPositive = isPositive + self.context = context + self.journey = journey + self.associatedValueField = associatedValueField + self.selfUri = selfUri + self.createdDate = createdDate + self.modifiedDate = modifiedDate + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case isActive + case displayName + case version + case _description = "description" + case isPositive + case context + case journey + case associatedValueField + case selfUri + case createdDate + case modifiedDate + } + + +} + + + + public class OutboundMessagingMessagingCampaignConfigChangeErrorDetail: Codable { @@ -28207,93 +28462,6 @@ public class OutboundMessagingMessagingCampaignConfigChangeResponseRef: Codable - -public class Outcome: Codable { - - - - - - - - - - - - - - - - - - - - - - - - - - /** ID of the outcome. */ - public var _id: String? - /** Whether or not the outcome is active. */ - public var isActive: Bool? - /** The display name of the outcome. */ - public var displayName: String? - /** The version of the outcome. */ - public var version: Int? - /** A description of the outcome. */ - public var _description: String? - /** Whether or not the outcome is positive. */ - public var isPositive: Bool? - /** The context of the outcome. */ - public var context: Context? - /** The pattern of rules defining the filter of the outcome. */ - public var journey: Journey? - /** The field from the event indicating the associated value. */ - public var associatedValueField: AssociatedValueField? - /** The URI for this object */ - public var selfUri: String? - /** 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 */ - public var createdDate: Date? - /** 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 */ - public var modifiedDate: Date? - - public init(_id: String?, isActive: Bool?, displayName: String?, version: Int?, _description: String?, isPositive: Bool?, context: Context?, journey: Journey?, associatedValueField: AssociatedValueField?, selfUri: String?, createdDate: Date?, modifiedDate: Date?) { - self._id = _id - self.isActive = isActive - self.displayName = displayName - self.version = version - self._description = _description - self.isPositive = isPositive - self.context = context - self.journey = journey - self.associatedValueField = associatedValueField - self.selfUri = selfUri - self.createdDate = createdDate - self.modifiedDate = modifiedDate - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case isActive - case displayName - case version - case _description = "description" - case isPositive - case context - case journey - case associatedValueField - case selfUri - case createdDate - case modifiedDate - } - - -} - - - /** A UriReference for a resource */ public class OutboundMessagingMessagingCampaignProgressEventUriReference: Codable { @@ -28353,24 +28521,24 @@ public class OutboundRouteEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [OutboundRoute]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [OutboundRoute]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -28501,23 +28669,23 @@ public class OutcomeListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Outcome]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Outcome]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -29111,24 +29279,24 @@ public class PhoneBaseEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [PhoneBase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [PhoneBase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -29613,6 +29781,176 @@ public class PublishedSurveyFormReference: Codable { +public class QualityAuditLogMessage: Codable { + + + + + + + + + + + + + + public enum ServiceName: String, Codable { + case recordingService = "RecordingService" + case recordingPlaybackService = "RecordingPlaybackService" + case qualityService = "QualityService" + } + + public enum Level: String, Codable { + case user = "User" + case system = "System" + case genesysInternal = "GENESYS_INTERNAL" + } + + public enum Status: String, Codable { + case success = "Success" + case failure = "Failure" + case warning = "Warning" + } + + + + + + public enum Action: String, Codable { + case read = "Read" + case create = "Create" + case update = "Update" + case delete = "Delete" + case abandon = "Abandon" + case archive = "Archive" + case export = "Export" + case download = "Download" + case restoreRequest = "RestoreRequest" + case restoreComplete = "RestoreComplete" + case applyProtection = "ApplyProtection" + case revokeProtection = "RevokeProtection" + case updateRetention = "UpdateRetention" + } + + + + public enum EntityType: String, Codable { + case recording = "Recording" + case evaluation = "Evaluation" + case calibration = "Calibration" + case annotation = "Annotation" + case screenRecording = "ScreenRecording" + case survey = "Survey" + } + + + + + + /** Id of the audit message. */ + public var _id: String? + /** Home Organization Id associated with this audit message. */ + public var userHomeOrgId: String? + /** Trustee Organization Id if this audit message is from trustee access. */ + public var userTrusteeOrgId: String? + /** User associated with this audit message. */ + public var user: DomainEntityRef? + /** Client associated with this audit message. */ + public var client: AddressableEntityRef? + /** List of IP addresses of systems that originated or handled the request. */ + public var remoteIps: [String]? + /** Name of the service that logged this audit message. */ + public var serviceName: ServiceName? + /** The level of this audit message. */ + public var level: Level? + /** The status of the action of this audit message. */ + public var status: Status? + /** 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 */ + public var eventDate: Date? + /** Message describing the event being audited. */ + public var messageInfo: MessageInfo? + /** Action that took place. */ + public var action: Action? + /** Entity that was impacted. */ + public var entity: DomainEntityRef? + /** Type of the entity that was impacted. */ + public var entityType: EntityType? + /** List of properties that were changed and changes made to those properties. */ + public var propertyChanges: [PropertyChange]? + /** Additional context for this message. */ + public var context: [String:String]? + + public init(_id: String?, userHomeOrgId: String?, userTrusteeOrgId: String?, user: DomainEntityRef?, client: AddressableEntityRef?, remoteIps: [String]?, serviceName: ServiceName?, level: Level?, status: Status?, eventDate: Date?, messageInfo: MessageInfo?, action: Action?, entity: DomainEntityRef?, entityType: EntityType?, propertyChanges: [PropertyChange]?, context: [String:String]?) { + self._id = _id + self.userHomeOrgId = userHomeOrgId + self.userTrusteeOrgId = userTrusteeOrgId + self.user = user + self.client = client + self.remoteIps = remoteIps + self.serviceName = serviceName + self.level = level + self.status = status + self.eventDate = eventDate + self.messageInfo = messageInfo + self.action = action + self.entity = entity + self.entityType = entityType + self.propertyChanges = propertyChanges + self.context = context + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case userHomeOrgId + case userTrusteeOrgId + case user + case client + case remoteIps + case serviceName + case level + case status + case eventDate + case messageInfo + case action + case entity + case entityType + case propertyChanges + case context + } + + +} + + + + +public class QueryRequestPredicate: Codable { + + public enum Dimension: String, Codable { + case attendeeid = "attendeeId" + case facilitatorid = "facilitatorId" + case status = "status" + } + + + + /** The dimension to be filtered */ + public var dimension: Dimension? + /** The value to filter by */ + public var value: String? + + public init(dimension: Dimension?, value: String?) { + self.dimension = dimension + self.value = value + } + + +} + + + + public class Queue: Codable { @@ -29868,176 +30206,6 @@ public class Queue: Codable { -public class QualityAuditLogMessage: Codable { - - - - - - - - - - - - - - public enum ServiceName: String, Codable { - case recordingService = "RecordingService" - case recordingPlaybackService = "RecordingPlaybackService" - case qualityService = "QualityService" - } - - public enum Level: String, Codable { - case user = "User" - case system = "System" - case genesysInternal = "GENESYS_INTERNAL" - } - - public enum Status: String, Codable { - case success = "Success" - case failure = "Failure" - case warning = "Warning" - } - - - - - - public enum Action: String, Codable { - case read = "Read" - case create = "Create" - case update = "Update" - case delete = "Delete" - case abandon = "Abandon" - case archive = "Archive" - case export = "Export" - case download = "Download" - case restoreRequest = "RestoreRequest" - case restoreComplete = "RestoreComplete" - case applyProtection = "ApplyProtection" - case revokeProtection = "RevokeProtection" - case updateRetention = "UpdateRetention" - } - - - - public enum EntityType: String, Codable { - case recording = "Recording" - case evaluation = "Evaluation" - case calibration = "Calibration" - case annotation = "Annotation" - case screenRecording = "ScreenRecording" - case survey = "Survey" - } - - - - - - /** Id of the audit message. */ - public var _id: String? - /** Home Organization Id associated with this audit message. */ - public var userHomeOrgId: String? - /** Trustee Organization Id if this audit message is from trustee access. */ - public var userTrusteeOrgId: String? - /** User associated with this audit message. */ - public var user: DomainEntityRef? - /** Client associated with this audit message. */ - public var client: AddressableEntityRef? - /** List of IP addresses of systems that originated or handled the request. */ - public var remoteIps: [String]? - /** Name of the service that logged this audit message. */ - public var serviceName: ServiceName? - /** The level of this audit message. */ - public var level: Level? - /** The status of the action of this audit message. */ - public var status: Status? - /** 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 */ - public var eventDate: Date? - /** Message describing the event being audited. */ - public var messageInfo: MessageInfo? - /** Action that took place. */ - public var action: Action? - /** Entity that was impacted. */ - public var entity: DomainEntityRef? - /** Type of the entity that was impacted. */ - public var entityType: EntityType? - /** List of properties that were changed and changes made to those properties. */ - public var propertyChanges: [PropertyChange]? - /** Additional context for this message. */ - public var context: [String:String]? - - public init(_id: String?, userHomeOrgId: String?, userTrusteeOrgId: String?, user: DomainEntityRef?, client: AddressableEntityRef?, remoteIps: [String]?, serviceName: ServiceName?, level: Level?, status: Status?, eventDate: Date?, messageInfo: MessageInfo?, action: Action?, entity: DomainEntityRef?, entityType: EntityType?, propertyChanges: [PropertyChange]?, context: [String:String]?) { - self._id = _id - self.userHomeOrgId = userHomeOrgId - self.userTrusteeOrgId = userTrusteeOrgId - self.user = user - self.client = client - self.remoteIps = remoteIps - self.serviceName = serviceName - self.level = level - self.status = status - self.eventDate = eventDate - self.messageInfo = messageInfo - self.action = action - self.entity = entity - self.entityType = entityType - self.propertyChanges = propertyChanges - self.context = context - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case userHomeOrgId - case userTrusteeOrgId - case user - case client - case remoteIps - case serviceName - case level - case status - case eventDate - case messageInfo - case action - case entity - case entityType - case propertyChanges - case context - } - - -} - - - - -public class QueryRequestPredicate: Codable { - - public enum Dimension: String, Codable { - case attendeeid = "attendeeId" - case facilitatorid = "facilitatorId" - case status = "status" - } - - - - /** The dimension to be filtered */ - public var dimension: Dimension? - /** The value to filter by */ - public var value: String? - - public init(dimension: Dimension?, value: String?) { - self.dimension = dimension - self.value = value - } - - -} - - - - public class QueueConversationCallEventTopicCallConversation: Codable { @@ -30246,6 +30414,63 @@ public class QueueConversationCallEventTopicUriReference: Codable { +public class QueueMember: Codable { + + + + + + + + + + + + + + + + + + /** The queue member's id. */ + public var _id: String? + public var name: String? + public var user: User? + public var ringNumber: Int? + public var joined: Bool? + public var memberBy: String? + public var routingStatus: RoutingStatus? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, name: String?, user: User?, ringNumber: Int?, joined: Bool?, memberBy: String?, routingStatus: RoutingStatus?, selfUri: String?) { + self._id = _id + self.name = name + self.user = user + self.ringNumber = ringNumber + self.joined = joined + self.memberBy = memberBy + self.routingStatus = routingStatus + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case user + case ringNumber + case joined + case memberBy + case routingStatus + case selfUri + } + + +} + + + + public class QueueConversationCallbackEventTopicDivisionEntityRef: Codable { @@ -30328,33 +30553,6 @@ public class QueueConversationCallbackEventTopicJourneyContext: Codable { -public class Record: Codable { - - - - - - - - /** The name of the record. */ - public var name: String? - /** The type of the record. (Example values: MX, TXT, CNAME) */ - public var type: String? - /** The value of the record. */ - public var value: String? - - public init(name: String?, type: String?, value: String?) { - self.name = name - self.type = type - self.value = value - } - - -} - - - - public class QueueConversationCallbackEventTopicWrapup: Codable { @@ -32704,63 +32902,6 @@ public class QueueConversationVideoEventTopicErrorDetails: Codable { -public class QueueMember: Codable { - - - - - - - - - - - - - - - - - - /** The queue member's id. */ - public var _id: String? - public var name: String? - public var user: User? - public var ringNumber: Int? - public var joined: Bool? - public var memberBy: String? - public var routingStatus: RoutingStatus? - /** The URI for this object */ - public var selfUri: String? - - public init(_id: String?, name: String?, user: User?, ringNumber: Int?, joined: Bool?, memberBy: String?, routingStatus: RoutingStatus?, selfUri: String?) { - self._id = _id - self.name = name - self.user = user - self.ringNumber = ringNumber - self.joined = joined - self.memberBy = memberBy - self.routingStatus = routingStatus - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - case user - case ringNumber - case joined - case memberBy - case routingStatus - case selfUri - } - - -} - - - - public class QueueObservationQueryResponse: Codable { @@ -33233,6 +33374,33 @@ public class RecognitionBase: Codable { +public class Record: Codable { + + + + + + + + /** The name of the record. */ + public var name: String? + /** The type of the record. (Example values: MX, TXT, CNAME) */ + public var type: String? + /** The value of the record. */ + public var value: String? + + public init(name: String?, type: String?, value: String?) { + self.name = name + self.type = type + self.value = value + } + + +} + + + + public class RecordingArchiveRestoreTopicRecording: Codable { @@ -35621,24 +35789,24 @@ public class SiteEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Site]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Site]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -35907,23 +36075,23 @@ public class SmsPhoneNumberEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SmsPhoneNumber]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SmsPhoneNumber]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -36186,23 +36354,23 @@ public class SubjectDivisionGrantsEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SubjectDivisionGrants]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SubjectDivisionGrants]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -36529,23 +36697,23 @@ public class SupportedContentListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SupportedContent]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SupportedContent]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -37536,6 +37704,33 @@ public class TransferRequest: Codable { +public class TransferResponseModifiedBy: Codable { + + + + + + /** The globally unique identifier for the object. */ + public var _id: String? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, selfUri: String?) { + self._id = _id + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case selfUri + } + + +} + + + + public class TransferToAgentRequest: Codable { public enum TransferType: String, Codable { @@ -37581,33 +37776,6 @@ public class TransferToAgentRequest: Codable { -public class TransferResponseModifiedBy: Codable { - - - - - - /** The globally unique identifier for the object. */ - public var _id: String? - /** The URI for this object */ - public var selfUri: String? - - public init(_id: String?, selfUri: String?) { - self._id = _id - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case selfUri - } - - -} - - - - public class TransferToExternalRequest: Codable { public enum TransferType: String, Codable { @@ -38873,23 +39041,23 @@ public class UserEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [User]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [User]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -39366,23 +39534,23 @@ public class UserRecordingEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UserRecording]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UserRecording]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -39689,23 +39857,23 @@ public class UtilizationLabelEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UtilizationLabel]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UtilizationLabel]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -40370,23 +40538,23 @@ public class VoicemailMessageEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [VoicemailMessage]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [VoicemailMessage]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } diff --git a/build/src/Models/PlatformAPIModelsP2.swift b/build/src/Models/PlatformAPIModelsP2.swift index 5d1580b53..c94c8146a 100644 --- a/build/src/Models/PlatformAPIModelsP2.swift +++ b/build/src/Models/PlatformAPIModelsP2.swift @@ -177,23 +177,23 @@ public class ActionEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Action]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Action]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -2038,23 +2038,23 @@ public class AttemptLimitsEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [AttemptLimits]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [AttemptLimits]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -2262,23 +2262,23 @@ public class AuthzDivisionEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [AuthzDivision]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [AuthzDivision]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -2420,15 +2420,6 @@ public class BatchDownloadJobResult: Codable { - - - - - - - /** The globally unique identifier for the object. */ - public var _id: String? - public var name: String? /** Conversation id of the result */ public var conversationId: String? /** Recording id of the result */ @@ -2439,29 +2430,13 @@ public class BatchDownloadJobResult: Codable { public var contentType: String? /** An error message, in case of failed processing will indicate the cause of the failure */ public var errorMsg: String? - /** The URI for this object */ - public var selfUri: String? - public init(_id: String?, name: String?, conversationId: String?, recordingId: String?, resultUrl: String?, contentType: String?, errorMsg: String?, selfUri: String?) { - self._id = _id - self.name = name + public init(conversationId: String?, recordingId: String?, resultUrl: String?, contentType: String?, errorMsg: String?) { self.conversationId = conversationId self.recordingId = recordingId self.resultUrl = resultUrl self.contentType = contentType self.errorMsg = errorMsg - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - case conversationId - case recordingId - case resultUrl - case contentType - case errorMsg - case selfUri } @@ -4088,23 +4063,23 @@ public class CallbackConversationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CallbackConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CallbackConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -4208,23 +4183,23 @@ public class CampaignDivisionViewListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CampaignDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CampaignDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5238,23 +5213,23 @@ public class ClientAppEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ClientApp]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ClientApp]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5332,23 +5307,23 @@ public class CoachingNotificationList: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CoachingNotification]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CoachingNotification]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5384,23 +5359,23 @@ public class CobrowseConversationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CobrowseConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CobrowseConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -6025,6 +6000,22 @@ public class ContactIdentifier: Codable { +public class ContactIdentifierListing: Codable { + + + + public var entities: [ContactIdentifier]? + + public init(entities: [ContactIdentifier]?) { + self.entities = entities + } + + +} + + + + public class ContactList: Codable { @@ -6179,23 +6170,23 @@ public class ContactListTemplateEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ContactListTemplate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ContactListTemplate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -6234,24 +6225,24 @@ public class ContactListingResponse: Codable { public var pageNumber: Int? public var total: Int64? public var contactsCount: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DialerContact]?, pageSize: Int?, pageNumber: Int?, total: Int64?, contactsCount: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DialerContact]?, pageSize: Int?, pageNumber: Int?, total: Int64?, contactsCount: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.contactsCount = contactsCount - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -9538,6 +9529,8 @@ public class ConversationSummaryTopicVirtualAgentsConversationSummaryEvent: Coda case conversationTooShort = "CONVERSATION_TOO_SHORT" } + + public var conversationId: UUID? public var participants: [ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant]? public var communicationIds: [String]? @@ -9554,8 +9547,9 @@ public class ConversationSummaryTopicVirtualAgentsConversationSummaryEvent: Coda public var triggerSource: ConversationSummaryTopicVirtualAgentsTriggerSource? public var lastEditedBy: ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant? public var errorType: ErrorType? + public var durationMs: Int? - public init(conversationId: UUID?, participants: [ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant]?, communicationIds: [String]?, createdDate: Date?, messageType: MessageType?, mediaType: MediaType?, summaryId: UUID?, language: String?, summary: ConversationSummaryTopicVirtualAgentsConversationSummary?, headline: ConversationSummaryTopicVirtualAgentsConversationHeadline?, reason: ConversationSummaryTopicVirtualAgentsConversationReason?, resolution: ConversationSummaryTopicVirtualAgentsConversationResolution?, wrapUpCodes: [ConversationSummaryTopicVirtualAgentsConversationWrapUpCode]?, triggerSource: ConversationSummaryTopicVirtualAgentsTriggerSource?, lastEditedBy: ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant?, errorType: ErrorType?) { + public init(conversationId: UUID?, participants: [ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant]?, communicationIds: [String]?, createdDate: Date?, messageType: MessageType?, mediaType: MediaType?, summaryId: UUID?, language: String?, summary: ConversationSummaryTopicVirtualAgentsConversationSummary?, headline: ConversationSummaryTopicVirtualAgentsConversationHeadline?, reason: ConversationSummaryTopicVirtualAgentsConversationReason?, resolution: ConversationSummaryTopicVirtualAgentsConversationResolution?, wrapUpCodes: [ConversationSummaryTopicVirtualAgentsConversationWrapUpCode]?, triggerSource: ConversationSummaryTopicVirtualAgentsTriggerSource?, lastEditedBy: ConversationSummaryTopicVirtualAgentsConversationSummaryParticipant?, errorType: ErrorType?, durationMs: Int?) { self.conversationId = conversationId self.participants = participants self.communicationIds = communicationIds @@ -9572,6 +9566,7 @@ public class ConversationSummaryTopicVirtualAgentsConversationSummaryEvent: Coda self.triggerSource = triggerSource self.lastEditedBy = lastEditedBy self.errorType = errorType + self.durationMs = durationMs } @@ -11053,23 +11048,23 @@ public class DIDNumberEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DIDNumber]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DIDNumber]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -11191,23 +11186,23 @@ public class DataTablesDomainEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DataTable]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DataTable]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -11281,6 +11276,7 @@ public class Dependency: Codable { case schedulegroup = "SCHEDULEGROUP" case secureaction = "SECUREACTION" case securecallflow = "SECURECALLFLOW" + case smsphonenumber = "SMSPHONENUMBER" case sttengine = "STTENGINE" case surveyform = "SURVEYFORM" case surveyinviteflow = "SURVEYINVITEFLOW" @@ -11372,23 +11368,23 @@ public class DependencyTypeEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DependencyType]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DependencyType]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12803,23 +12799,23 @@ public class DocumentEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Document]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Document]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -14172,23 +14168,23 @@ public class EmailCampaignScheduleEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EmailCampaignSchedule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EmailCampaignSchedule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -15484,28 +15480,6 @@ public class ExecutionDataEntity: Codable { -public class Facet: Codable { - - - - - - /** The name of the field on which to facet. */ - public var name: String? - /** The type of the facet, DATE or STRING. */ - public var type: String? - - public init(name: String?, type: String?) { - self.name = name - self.type = type - } - - -} - - - - public class ExportScriptResponse: Codable { @@ -15834,31 +15808,6 @@ public class ExternalContactsUnresolvedContactChangedTopicExternalSource: Codabl -/** Describes a link to a record in an external system that contributed data to a Relate record */ - -public class ExternalDataSource: Codable { - - public enum Platform: String, Codable { - case salesforce = "SALESFORCE" - } - - - - /** The platform that was the source of the data. Example: a CRM like SALESFORCE. */ - public var platform: Platform? - /** An URL that links to the source record that contributed data to the associated entity. */ - public var url: String? - - public init(platform: Platform?, url: String?) { - self.platform = platform - self.url = url - } - - -} - - - public class ExternalContactsUnresolvedContactChangedTopicLineId: Codable { @@ -15915,6 +15864,31 @@ public class ExternalContactsUnresolvedContactChangedTopicTicker: Codable { +/** Describes a link to a record in an external system that contributed data to a Relate record */ + +public class ExternalDataSource: Codable { + + public enum Platform: String, Codable { + case salesforce = "SALESFORCE" + } + + + + /** The platform that was the source of the data. Example: a CRM like SALESFORCE. */ + public var platform: Platform? + /** An URL that links to the source record that contributed data to the associated entity. */ + public var url: String? + + public init(platform: Platform?, url: String?) { + self.platform = platform + self.url = url + } + + +} + + + public class ExternalId: Codable { @@ -16058,6 +16032,28 @@ public class FacebookScopedId: Codable { +public class Facet: Codable { + + + + + + /** The name of the field on which to facet. */ + public var name: String? + /** The type of the facet, DATE or STRING. */ + public var type: String? + + public init(name: String?, type: String?) { + self.name = name + self.type = type + } + + +} + + + + public class FacetEntry: Codable { @@ -16165,23 +16161,23 @@ public class FailedRecordingEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [RecordingJobFailedRecording]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [RecordingJobFailedRecording]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16992,23 +16988,23 @@ public class FlowDivisionViewEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FlowDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FlowDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18398,6 +18394,78 @@ public class ForecastPlanningGroupsResponse: Codable { +public class GSuite: Codable { + + + + + + + + + + + + + + + + + + + + + + + + /** The globally unique identifier for the object. */ + public var _id: String? + public var name: String? + public var disabled: Bool? + public var issuerURI: String? + public var ssoTargetURI: String? + public var sloURI: String? + public var sloBinding: String? + public var relyingPartyIdentifier: String? + public var certificate: String? + public var certificates: [String]? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, name: String?, disabled: Bool?, issuerURI: String?, ssoTargetURI: String?, sloURI: String?, sloBinding: String?, relyingPartyIdentifier: String?, certificate: String?, certificates: [String]?, selfUri: String?) { + self._id = _id + self.name = name + self.disabled = disabled + self.issuerURI = issuerURI + self.ssoTargetURI = ssoTargetURI + self.sloURI = sloURI + self.sloBinding = sloBinding + self.relyingPartyIdentifier = relyingPartyIdentifier + self.certificate = certificate + self.certificates = certificates + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case disabled + case issuerURI + case ssoTargetURI + case sloURI + case sloBinding + case relyingPartyIdentifier + case certificate + case certificates + case selfUri + } + + +} + + + + public class FreeTrialLimitDocs: Codable { @@ -18464,23 +18532,23 @@ public class GDPRRequestEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [GDPRRequest]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [GDPRRequest]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18516,23 +18584,23 @@ public class GDPRSubjectEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [GDPRSubject]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [GDPRSubject]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18581,78 +18649,6 @@ public class GKNDocumentationResult: Codable { -public class GSuite: Codable { - - - - - - - - - - - - - - - - - - - - - - - - /** The globally unique identifier for the object. */ - public var _id: String? - public var name: String? - public var disabled: Bool? - public var issuerURI: String? - public var ssoTargetURI: String? - public var sloURI: String? - public var sloBinding: String? - public var relyingPartyIdentifier: String? - public var certificate: String? - public var certificates: [String]? - /** The URI for this object */ - public var selfUri: String? - - public init(_id: String?, name: String?, disabled: Bool?, issuerURI: String?, ssoTargetURI: String?, sloURI: String?, sloBinding: String?, relyingPartyIdentifier: String?, certificate: String?, certificates: [String]?, selfUri: String?) { - self._id = _id - self.name = name - self.disabled = disabled - self.issuerURI = issuerURI - self.ssoTargetURI = ssoTargetURI - self.sloURI = sloURI - self.sloBinding = sloBinding - self.relyingPartyIdentifier = relyingPartyIdentifier - self.certificate = certificate - self.certificates = certificates - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - case disabled - case issuerURI - case ssoTargetURI - case sloURI - case sloBinding - case relyingPartyIdentifier - case certificate - case certificates - case selfUri - } - - -} - - - - public class GamificationScorecardChangeTopicPerformanceMetric: Codable { @@ -18992,23 +18988,23 @@ public class GroupProfileEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [GroupProfile]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [GroupProfile]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19207,24 +19203,24 @@ public class IVREntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [IVR]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [IVR]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19581,23 +19577,23 @@ public class InboundRouteEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [InboundRoute]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [InboundRoute]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19651,23 +19647,23 @@ public class IntegrationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Integration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Integration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19877,23 +19873,23 @@ public class InteractionStatsRuleContainer: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [InteractionStatsRule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [InteractionStatsRule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -23590,23 +23586,23 @@ public class LexV2BotAliasEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LexV2BotAlias]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LexV2BotAlias]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -23642,23 +23638,23 @@ public class LexV2BotEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LexV2Bot]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LexV2Bot]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -23942,24 +23938,24 @@ public class LineBaseEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LineBase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LineBase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -24628,23 +24624,23 @@ public class MessagingCampaignEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [MessagingCampaign]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [MessagingCampaign]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -25240,23 +25236,23 @@ public class NluDomainListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [NluDomain]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [NluDomain]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -26079,6 +26075,67 @@ public class OpenIntegration: Codable { +public class Operand: Codable { + + public enum ModelType: String, Codable { + case term = "Term" + case topic = "Topic" + case operandGroup = "OperandGroup" + } + + + + + + + + + + + + + + + + + + /** The Operand type of the category */ + public var type: ModelType? + /** The minimum number of occurrences of the defined operand type */ + public var occurrence: Int? + /** Applies a NOT modifier to the operand group */ + public var inverted: Bool? + /** Filter interaction by word(s) */ + public var term: Term? + /** Filter interaction by topic ID */ + public var topicId: String? + /** Dictates when the operand must occur in a voice interaction */ + public var voiceSecondsPosition: OperandPosition? + /** Dictates when the operand must occur in a digital interaction */ + public var digitalWordsPosition: OperandPosition? + /** Defines a logical operation that is applied on the current operand, against the following operand */ + public var infixOperator: InfixOperator? + /** Contains a new level of operands */ + public var operands: [Operand]? + + public init(type: ModelType?, occurrence: Int?, inverted: Bool?, term: Term?, topicId: String?, voiceSecondsPosition: OperandPosition?, digitalWordsPosition: OperandPosition?, infixOperator: InfixOperator?, operands: [Operand]?) { + self.type = type + self.occurrence = occurrence + self.inverted = inverted + self.term = term + self.topicId = topicId + self.voiceSecondsPosition = voiceSecondsPosition + self.digitalWordsPosition = digitalWordsPosition + self.infixOperator = infixOperator + self.operands = operands + } + + +} + + + + public class OpenIntegrationRequest: Codable { @@ -26204,67 +26261,6 @@ public class OpenMessagingFromRecipient: Codable { -public class Operand: Codable { - - public enum ModelType: String, Codable { - case term = "Term" - case topic = "Topic" - case operandGroup = "OperandGroup" - } - - - - - - - - - - - - - - - - - - /** The Operand type of the category */ - public var type: ModelType? - /** The minimum number of occurrences of the defined operand type */ - public var occurrence: Int? - /** Applies a NOT modifier to the operand group */ - public var inverted: Bool? - /** Filter interaction by word(s) */ - public var term: Term? - /** Filter interaction by topic ID */ - public var topicId: String? - /** Dictates when the operand must occur in a voice interaction */ - public var voiceSecondsPosition: OperandPosition? - /** Dictates when the operand must occur in a digital interaction */ - public var digitalWordsPosition: OperandPosition? - /** Defines a logical operation that is applied on the current operand, against the following operand */ - public var infixOperator: InfixOperator? - /** Contains a new level of operands */ - public var operands: [Operand]? - - public init(type: ModelType?, occurrence: Int?, inverted: Bool?, term: Term?, topicId: String?, voiceSecondsPosition: OperandPosition?, digitalWordsPosition: OperandPosition?, infixOperator: InfixOperator?, operands: [Operand]?) { - self.type = type - self.occurrence = occurrence - self.inverted = inverted - self.term = term - self.topicId = topicId - self.voiceSecondsPosition = voiceSecondsPosition - self.digitalWordsPosition = digitalWordsPosition - self.infixOperator = infixOperator - self.operands = operands - } - - -} - - - - public class OrganizationPresenceDefinition: Codable { @@ -26396,23 +26392,23 @@ public class OrganizationRoleEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DomainOrganizationRole]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DomainOrganizationRole]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -27520,23 +27516,23 @@ public class PermissionCollectionEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DomainPermissionCollection]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DomainPermissionCollection]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -27546,6 +27542,30 @@ public class PermissionCollectionEntityListing: Codable { +public class PersistentConnectionChangeTopicErrorLocation: Codable { + + + + + + + + public var function: String? + public var fileID: String? + public var line: Int? + + public init(function: String?, fileID: String?, line: Int?) { + self.function = function + self.fileID = fileID + self.line = line + } + + +} + + + + public class PhoneChangeTopicEdgeReference: Codable { @@ -27628,24 +27648,24 @@ public class PhoneEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Phone]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Phone]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -27742,24 +27762,24 @@ public class PhoneMetaBaseEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Metabase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Metabase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -33004,17 +33024,22 @@ public class RegionTimeZone: Codable { + + /** The globally unique identifier for the object. */ public var _id: String? public var name: String? public var offset: Int64? + /** Canonical identifier for this time zone, if applicable */ + public var canonicalId: String? /** The URI for this object */ public var selfUri: String? - public init(_id: String?, name: String?, offset: Int64?, selfUri: String?) { + public init(_id: String?, name: String?, offset: Int64?, canonicalId: String?, selfUri: String?) { self._id = _id self.name = name self.offset = offset + self.canonicalId = canonicalId self.selfUri = selfUri } @@ -33022,6 +33047,7 @@ public class RegionTimeZone: Codable { case _id = "id" case name case offset + case canonicalId case selfUri } @@ -34080,24 +34106,24 @@ public class ScheduleDivisionViewEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SchedulesDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SchedulesDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -34396,24 +34422,24 @@ public class ScheduleGroupDivisionViewEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ScheduleGroupDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ScheduleGroupDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -35254,23 +35280,23 @@ public class ScreenRecordingSessionListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ScreenRecordingSession]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ScreenRecordingSession]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -35461,23 +35487,23 @@ public class SegmentListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [JourneySegment]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [JourneySegment]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -35655,17 +35681,22 @@ public class ServiceNowSettings: Codable { + + /** Filter source by knowledge base ids. */ public var knowledgeBaseIds: [String]? /** Filter source by language. */ public var language: String? /** Filter source by categories. */ public var categories: [String]? + /** The base URL to resources. */ + public var baseUrl: String? - public init(knowledgeBaseIds: [String]?, language: String?, categories: [String]?) { + public init(knowledgeBaseIds: [String]?, language: String?, categories: [String]?, baseUrl: String?) { self.knowledgeBaseIds = knowledgeBaseIds self.language = language self.categories = categories + self.baseUrl = baseUrl } @@ -36064,23 +36095,23 @@ public class SkillEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [RoutingSkill]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [RoutingSkill]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -37875,23 +37906,23 @@ public class TimeZoneEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [RegionTimeZone]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [RegionTimeZone]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -37918,16 +37949,16 @@ public class TopicsEntityListing: Codable { public var entities: [ListedTopic]? public var pageSize: Int? public var total: Int? - public var nextUri: String? public var selfUri: String? + public var nextUri: String? public var pageCount: Int? - public init(entities: [ListedTopic]?, pageSize: Int?, total: Int?, nextUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ListedTopic]?, pageSize: Int?, total: Int?, selfUri: String?, nextUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.total = total - self.nextUri = nextUri self.selfUri = selfUri + self.nextUri = nextUri self.pageCount = pageCount } @@ -38395,24 +38426,24 @@ public class TrunkBaseEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [TrunkBase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [TrunkBase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -38470,23 +38501,23 @@ public class TrustEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Trustee]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Trustee]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -38522,23 +38553,23 @@ public class TrustGroupEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [TrustGroup]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [TrustGroup]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -38574,23 +38605,23 @@ public class TrustUserEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [TrustUser]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [TrustUser]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -38872,23 +38903,23 @@ public class TrustorEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Trustor]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Trustor]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -39055,23 +39086,23 @@ public class UCIntegrationListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UCIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UCIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -39621,157 +39652,6 @@ public class UserAuthorization: Codable { -public class UserDetailQueryFilter: Codable { - - public enum ModelType: String, Codable { - case and = "and" - case or = "or" - } - - - - - - /** Boolean operation to apply to the provided predicates and clauses */ - public var type: ModelType? - /** Boolean 'and/or' logic with up to two-levels of nesting */ - public var clauses: [UserDetailQueryClause]? - /** Like a three-word sentence: (attribute-name) (operator) (target-value). */ - public var predicates: [UserDetailQueryPredicate]? - - public init(type: ModelType?, clauses: [UserDetailQueryClause]?, predicates: [UserDetailQueryPredicate]?) { - self.type = type - self.clauses = clauses - self.predicates = predicates - } - - -} - - - - -public class UserDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification: Codable { - - - - /** Date and time before which data is guaranteed to be available in the datalake */ - public var dataAvailabilityDate: Date? - - public init(dataAvailabilityDate: Date?) { - self.dataAvailabilityDate = dataAvailabilityDate - } - - -} - - - - -public class UserExpands: Codable { - - - - - - - - - - - - - - - - - - /** ACD routing status */ - public var routingStatus: RoutingStatus? - /** Active presence */ - public var presence: UserPresence? - /** Active 3rd party presence */ - public var integrationPresence: UserPresence? - /** Summary of conversion statistics for conversation types. */ - public var conversationSummary: UserConversationSummary? - /** Determine if out of office is enabled */ - public var outOfOffice: OutOfOffice? - /** Current geolocation position */ - public var geolocation: Geolocation? - /** Effective, default, and last station information */ - public var station: UserStations? - /** Roles and permissions assigned to the user */ - public var authorization: UserAuthorization? - - public init(routingStatus: RoutingStatus?, presence: UserPresence?, integrationPresence: UserPresence?, conversationSummary: UserConversationSummary?, outOfOffice: OutOfOffice?, geolocation: Geolocation?, station: UserStations?, authorization: UserAuthorization?) { - self.routingStatus = routingStatus - self.presence = presence - self.integrationPresence = integrationPresence - self.conversationSummary = conversationSummary - self.outOfOffice = outOfOffice - self.geolocation = geolocation - self.station = station - self.authorization = authorization - } - - -} - - - - -public class UserGreetingEventGreetingAudioFile: Codable { - - - - - - public var durationMilliseconds: Int? - public var sizeBytes: Int? - - public init(durationMilliseconds: Int?, sizeBytes: Int?) { - self.durationMilliseconds = durationMilliseconds - self.sizeBytes = sizeBytes - } - - -} - - - - -public class UserListScheduleRequestBody: Codable { - - - - - - - - - - /** The user ids for which to fetch schedules */ - public var userIds: [String]? - /** Beginning of the range of schedules to fetch, in ISO-8601 format */ - public var startDate: Date? - /** End of the range of schedules to fetch, in ISO-8601 format */ - public var endDate: Date? - /** 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 */ - public var loadFullWeeks: Bool? - - public init(userIds: [String]?, startDate: Date?, endDate: Date?, loadFullWeeks: Bool?) { - self.userIds = userIds - self.startDate = startDate - self.endDate = endDate - self.loadFullWeeks = loadFullWeeks - } - - -} - - - - public class UserMe: Codable { @@ -40109,6 +39989,157 @@ public class UserMe: Codable { +public class UserDetailQueryFilter: Codable { + + public enum ModelType: String, Codable { + case and = "and" + case or = "or" + } + + + + + + /** Boolean operation to apply to the provided predicates and clauses */ + public var type: ModelType? + /** Boolean 'and/or' logic with up to two-levels of nesting */ + public var clauses: [UserDetailQueryClause]? + /** Like a three-word sentence: (attribute-name) (operator) (target-value). */ + public var predicates: [UserDetailQueryPredicate]? + + public init(type: ModelType?, clauses: [UserDetailQueryClause]?, predicates: [UserDetailQueryPredicate]?) { + self.type = type + self.clauses = clauses + self.predicates = predicates + } + + +} + + + + +public class UserDetailsDatalakeAvailabilityTopicDataAvailabilityChangeNotification: Codable { + + + + /** Date and time before which data is guaranteed to be available in the datalake */ + public var dataAvailabilityDate: Date? + + public init(dataAvailabilityDate: Date?) { + self.dataAvailabilityDate = dataAvailabilityDate + } + + +} + + + + +public class UserExpands: Codable { + + + + + + + + + + + + + + + + + + /** ACD routing status */ + public var routingStatus: RoutingStatus? + /** Active presence */ + public var presence: UserPresence? + /** Active 3rd party presence */ + public var integrationPresence: UserPresence? + /** Summary of conversion statistics for conversation types. */ + public var conversationSummary: UserConversationSummary? + /** Determine if out of office is enabled */ + public var outOfOffice: OutOfOffice? + /** Current geolocation position */ + public var geolocation: Geolocation? + /** Effective, default, and last station information */ + public var station: UserStations? + /** Roles and permissions assigned to the user */ + public var authorization: UserAuthorization? + + public init(routingStatus: RoutingStatus?, presence: UserPresence?, integrationPresence: UserPresence?, conversationSummary: UserConversationSummary?, outOfOffice: OutOfOffice?, geolocation: Geolocation?, station: UserStations?, authorization: UserAuthorization?) { + self.routingStatus = routingStatus + self.presence = presence + self.integrationPresence = integrationPresence + self.conversationSummary = conversationSummary + self.outOfOffice = outOfOffice + self.geolocation = geolocation + self.station = station + self.authorization = authorization + } + + +} + + + + +public class UserGreetingEventGreetingAudioFile: Codable { + + + + + + public var durationMilliseconds: Int? + public var sizeBytes: Int? + + public init(durationMilliseconds: Int?, sizeBytes: Int?) { + self.durationMilliseconds = durationMilliseconds + self.sizeBytes = sizeBytes + } + + +} + + + + +public class UserListScheduleRequestBody: Codable { + + + + + + + + + + /** The user ids for which to fetch schedules */ + public var userIds: [String]? + /** Beginning of the range of schedules to fetch, in ISO-8601 format */ + public var startDate: Date? + /** End of the range of schedules to fetch, in ISO-8601 format */ + public var endDate: Date? + /** 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 */ + public var loadFullWeeks: Bool? + + public init(userIds: [String]?, startDate: Date?, endDate: Date?, loadFullWeeks: Bool?) { + self.userIds = userIds + self.startDate = startDate + self.endDate = endDate + self.loadFullWeeks = loadFullWeeks + } + + +} + + + + public class UserObservationDataContainer: Codable { @@ -40214,23 +40245,23 @@ public class UserProfileEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UserProfile]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UserProfile]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -40853,23 +40884,23 @@ public class UserSkillEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UserRoutingSkill]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UserRoutingSkill]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -41090,6 +41121,50 @@ public class UserTimeOffRequestReference: Codable { +public class Verifier: Codable { + + + + + + + + + + + + /** The globally unique identifier for the object. */ + public var _id: String? + public var name: String? + /** Indicates whether this verifier is enabled. */ + public var enabled: Bool? + /** Indicates whether this is the default verifier. */ + public var _default: Bool? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, name: String?, enabled: Bool?, _default: Bool?, selfUri: String?) { + self._id = _id + self.name = name + self.enabled = enabled + self._default = _default + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case enabled + case _default = "default" + case selfUri + } + + +} + + + + public class V2ConversationMessageTypingEventForUserTopicConversationMessageEvent: Codable { public enum EventType: String, Codable { @@ -41513,50 +41588,6 @@ public class ValueWrapperDate: Codable { -public class Verifier: Codable { - - - - - - - - - - - - /** The globally unique identifier for the object. */ - public var _id: String? - public var name: String? - /** Indicates whether this verifier is enabled. */ - public var enabled: Bool? - /** Indicates whether this is the default verifier. */ - public var _default: Bool? - /** The URI for this object */ - public var selfUri: String? - - public init(_id: String?, name: String?, enabled: Bool?, _default: Bool?, selfUri: String?) { - self._id = _id - self.name = name - self.enabled = enabled - self._default = _default - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - case enabled - case _default = "default" - case selfUri - } - - -} - - - - public class Video: Codable { public enum State: String, Codable { @@ -42685,6 +42716,78 @@ public class WfmActivityPlanJobCompleteTopicActivityPlanReference: Codable { +public class WfmActivityPlanRunJobCompleteTopicActivityPlanRunJobCompleteNotification: Codable { + + + + public enum ModelType: String, Codable { + case runPlan = "RunPlan" + case deleteOccurrence = "DeleteOccurrence" + } + + + + public enum Status: String, Codable { + case processing = "Processing" + case complete = "Complete" + case error = "Error" + } + + + + + + public var _id: String? + public var type: ModelType? + public var activityPlan: WfmActivityPlanRunJobCompleteTopicActivityPlanReference? + public var status: Status? + public var exceptions: [WfmActivityPlanRunJobCompleteTopicActivityPlanJobException]? + public var error: WfmActivityPlanRunJobCompleteTopicErrorBody? + + public init(_id: String?, type: ModelType?, activityPlan: WfmActivityPlanRunJobCompleteTopicActivityPlanReference?, status: Status?, exceptions: [WfmActivityPlanRunJobCompleteTopicActivityPlanJobException]?, error: WfmActivityPlanRunJobCompleteTopicErrorBody?) { + self._id = _id + self.type = type + self.activityPlan = activityPlan + self.status = status + self.exceptions = exceptions + self.error = error + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case type + case activityPlan + case status + case exceptions + case error + } + + +} + + + + +public class WfmAdherenceExplanationJobCompleteTopicUserReference: Codable { + + + + public var _id: String? + + public init(_id: String?) { + self._id = _id + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + } + + +} + + + + public class WfmAgent: Codable { @@ -42772,78 +42875,6 @@ public class WfmAgent: Codable { -public class WfmActivityPlanRunJobCompleteTopicActivityPlanRunJobCompleteNotification: Codable { - - - - public enum ModelType: String, Codable { - case runPlan = "RunPlan" - case deleteOccurrence = "DeleteOccurrence" - } - - - - public enum Status: String, Codable { - case processing = "Processing" - case complete = "Complete" - case error = "Error" - } - - - - - - public var _id: String? - public var type: ModelType? - public var activityPlan: WfmActivityPlanRunJobCompleteTopicActivityPlanReference? - public var status: Status? - public var exceptions: [WfmActivityPlanRunJobCompleteTopicActivityPlanJobException]? - public var error: WfmActivityPlanRunJobCompleteTopicErrorBody? - - public init(_id: String?, type: ModelType?, activityPlan: WfmActivityPlanRunJobCompleteTopicActivityPlanReference?, status: Status?, exceptions: [WfmActivityPlanRunJobCompleteTopicActivityPlanJobException]?, error: WfmActivityPlanRunJobCompleteTopicErrorBody?) { - self._id = _id - self.type = type - self.activityPlan = activityPlan - self.status = status - self.exceptions = exceptions - self.error = error - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case type - case activityPlan - case status - case exceptions - case error - } - - -} - - - - -public class WfmAdherenceExplanationJobCompleteTopicUserReference: Codable { - - - - public var _id: String? - - public init(_id: String?) { - self._id = _id - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - } - - -} - - - - public class WfmAgentAdherenceExplanationChangedAgentTopicAdherenceExplanationChangedNotification: Codable { diff --git a/build/src/Models/PlatformAPIModelsP3.swift b/build/src/Models/PlatformAPIModelsP3.swift index cd72b9322..aecbdf5a9 100644 --- a/build/src/Models/PlatformAPIModelsP3.swift +++ b/build/src/Models/PlatformAPIModelsP3.swift @@ -227,23 +227,23 @@ public class ActionCertificateListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ActionCertificate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ActionCertificate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -476,23 +476,23 @@ public class ActionTemplateListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ActionTemplate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ActionTemplate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -1680,23 +1680,23 @@ public class AlertListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CommonAlert]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CommonAlert]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -3768,23 +3768,23 @@ public class BotConnectorBotVersionSummaryEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [BotVersionSummary]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [BotVersionSummary]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -4678,23 +4678,23 @@ public class CachedMediaItemEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CachedMediaItem]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CachedMediaItem]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5233,23 +5233,23 @@ public class CertificateAuthorityEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DomainCertificateAuthority]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DomainCertificateAuthority]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5468,23 +5468,23 @@ public class CoachingAnnotationList: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CoachingAnnotation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CoachingAnnotation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5690,23 +5690,23 @@ public class CommandStatusEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CommandStatus]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CommandStatus]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5742,23 +5742,23 @@ public class CommonCampaignEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CommonCampaign]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CommonCampaign]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5941,23 +5941,23 @@ public class ConsumingResourcesEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Dependency]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Dependency]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -6041,6 +6041,49 @@ public class ContactColumnTimeZone: Codable { +public class ContactImportJobRequest: Codable { + + + + /** Settings id */ + public var settingsId: String? + + public init(settingsId: String?) { + self.settingsId = settingsId + } + + +} + + + + +public class ContactImportJobStatusUpdateRequest: Codable { + + + + public enum Status: String, Codable { + case _continue = "Continue" + case cancel = "Cancel" + case retry = "Retry" + } + + /** Job Id */ + public var jobId: String? + /** Workflow status */ + public var status: Status? + + public init(jobId: String?, status: Status?) { + self.jobId = jobId + self.status = status + } + + +} + + + + public class ContactListFilterEntityListing: Codable { @@ -6067,23 +6110,23 @@ public class ContactListFilterEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ContactListFilter]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ContactListFilter]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -6416,129 +6459,6 @@ public class ContentManagementSingleDocumentTopicDocumentDataV2: Codable { - -public class DID: Codable { - - - - - - - - - - - - - - - - - - - - public enum State: String, Codable { - case active = "active" - case inactive = "inactive" - case deleted = "deleted" - } - - - - - - - - - - - - public enum OwnerType: String, Codable { - case user = "USER" - case phone = "PHONE" - case ivrConfig = "IVR_CONFIG" - case group = "GROUP" - } - - - - /** The globally unique identifier for the object. */ - public var _id: String? - /** The name of the entity. */ - public var name: String? - /** The division to which this entity belongs. */ - public var division: Division? - /** The resource's description. */ - public var _description: String? - /** The current version of the resource. */ - public var version: Int? - /** The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ - public var dateCreated: Date? - /** 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 */ - public var dateModified: Date? - /** The ID of the user that last modified the resource. */ - public var modifiedBy: String? - /** The ID of the user that created the resource. */ - public var createdBy: String? - /** Indicates if the resource is active, inactive, or deleted. */ - public var state: State? - /** The application that last modified the resource. */ - public var modifiedByApp: String? - /** The application that created the resource. */ - public var createdByApp: String? - public var phoneNumber: String? - public var didPool: DomainEntityRef? - /** A Uri reference to the owner of this DID, which is either a User or an IVR */ - public var owner: DomainEntityRef? - public var ownerType: OwnerType? - /** The URI for this object */ - public var selfUri: String? - - public init(_id: String?, name: String?, division: Division?, _description: String?, version: Int?, dateCreated: Date?, dateModified: Date?, modifiedBy: String?, createdBy: String?, state: State?, modifiedByApp: String?, createdByApp: String?, phoneNumber: String?, didPool: DomainEntityRef?, owner: DomainEntityRef?, ownerType: OwnerType?, selfUri: String?) { - self._id = _id - self.name = name - self.division = division - self._description = _description - self.version = version - self.dateCreated = dateCreated - self.dateModified = dateModified - self.modifiedBy = modifiedBy - self.createdBy = createdBy - self.state = state - self.modifiedByApp = modifiedByApp - self.createdByApp = createdByApp - self.phoneNumber = phoneNumber - self.didPool = didPool - self.owner = owner - self.ownerType = ownerType - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - case division - case _description = "description" - case version - case dateCreated - case dateModified - case modifiedBy - case createdBy - case state - case modifiedByApp - case createdByApp - case phoneNumber - case didPool - case owner - case ownerType - case selfUri - } - - -} - - - /** Template notification object. */ public class ContentNotificationTemplate: Codable { @@ -7951,6 +7871,7 @@ public class ConversationContentButtonResponse: Codable { public enum ModelType: String, Codable { case button = "Button" case quickReply = "QuickReply" + case datePicker = "DatePicker" } @@ -8027,6 +7948,49 @@ public class ConversationContentCard: Codable { +/** DateTimePicker content object. */ + +public class ConversationContentDatePicker: Codable { + + + + + + + + + + + + + + /** Text to show in the title. */ + public var title: String? + /** Text to show in the description. */ + public var subtitle: String? + /** URL of an image */ + public var imageUrl: String? + /** The minimum Date Enabled in the datepicker calendar, format: ISO 8601. */ + public var dateMinimum: Date? + /** The maximum Date Enabled in the datepicker calendar, format: ISO 8601. */ + public var dateMaximum: Date? + /** An array of available times objects. */ + public var availableTimes: [ConversationContentDatePickerAvailableTime]? + + public init(title: String?, subtitle: String?, imageUrl: String?, dateMinimum: Date?, dateMaximum: Date?, availableTimes: [ConversationContentDatePickerAvailableTime]?) { + self.title = title + self.subtitle = subtitle + self.imageUrl = imageUrl + self.dateMinimum = dateMinimum + self.dateMaximum = dateMaximum + self.availableTimes = availableTimes + } + + +} + + + /** Template notification object. */ public class ConversationContentNotificationTemplate: Codable { @@ -8855,6 +8819,129 @@ public class ConversationEventTopicMessageMedia: Codable { +public class DID: Codable { + + + + + + + + + + + + + + + + + + + + public enum State: String, Codable { + case active = "active" + case inactive = "inactive" + case deleted = "deleted" + } + + + + + + + + + + + + public enum OwnerType: String, Codable { + case user = "USER" + case phone = "PHONE" + case ivrConfig = "IVR_CONFIG" + case group = "GROUP" + } + + + + /** The globally unique identifier for the object. */ + public var _id: String? + /** The name of the entity. */ + public var name: String? + /** The division to which this entity belongs. */ + public var division: Division? + /** The resource's description. */ + public var _description: String? + /** The current version of the resource. */ + public var version: Int? + /** The date the resource was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateCreated: Date? + /** 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 */ + public var dateModified: Date? + /** The ID of the user that last modified the resource. */ + public var modifiedBy: String? + /** The ID of the user that created the resource. */ + public var createdBy: String? + /** Indicates if the resource is active, inactive, or deleted. */ + public var state: State? + /** The application that last modified the resource. */ + public var modifiedByApp: String? + /** The application that created the resource. */ + public var createdByApp: String? + public var phoneNumber: String? + public var didPool: DomainEntityRef? + /** A Uri reference to the owner of this DID, which is either a User or an IVR */ + public var owner: DomainEntityRef? + public var ownerType: OwnerType? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, name: String?, division: Division?, _description: String?, version: Int?, dateCreated: Date?, dateModified: Date?, modifiedBy: String?, createdBy: String?, state: State?, modifiedByApp: String?, createdByApp: String?, phoneNumber: String?, didPool: DomainEntityRef?, owner: DomainEntityRef?, ownerType: OwnerType?, selfUri: String?) { + self._id = _id + self.name = name + self.division = division + self._description = _description + self.version = version + self.dateCreated = dateCreated + self.dateModified = dateModified + self.modifiedBy = modifiedBy + self.createdBy = createdBy + self.state = state + self.modifiedByApp = modifiedByApp + self.createdByApp = createdByApp + self.phoneNumber = phoneNumber + self.didPool = didPool + self.owner = owner + self.ownerType = ownerType + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case division + case _description = "description" + case version + case dateCreated + case dateModified + case modifiedBy + case createdBy + case state + case modifiedByApp + case createdByApp + case phoneNumber + case didPool + case owner + case ownerType + case selfUri + } + + +} + + + + public class ConversationEventTopicMessageMetadataEvent: Codable { @@ -12081,23 +12168,23 @@ public class DashboardUserListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DashboardUser]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DashboardUser]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12289,23 +12376,23 @@ public class DependencyObjectEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DependencyObject]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DependencyObject]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12972,34 +13059,6 @@ public class DialerContactlistfilterConfigChangeUriReference: Codable { - /** The ID of the resource */ - public var _id: String? - /** The name of the resource */ - public var name: String? - - public init(_id: String?, name: String?) { - self._id = _id - self.name = name - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - } - - -} - - - -/** A UriReference for a resource */ - -public class DialerDnclistConfigChangeUriReference: Codable { - - - - - /** The ID of the resource */ public var _id: String? /** The name of the resource */ @@ -13047,23 +13106,23 @@ public class DialerEventEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EventLog]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EventLog]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -13072,6 +13131,34 @@ public class DialerEventEntityListing: Codable { +/** A UriReference for a resource */ + +public class DialerDnclistConfigChangeUriReference: Codable { + + + + + + /** The ID of the resource */ + public var _id: String? + /** The name of the resource */ + public var name: String? + + public init(_id: String?, name: String?) { + self._id = _id + self.name = name + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + } + + +} + + + /** The time interval to place outbound calls */ public class DialerOutboundSettingsConfigChangeAtzmTimeSlot: Codable { @@ -13326,23 +13413,23 @@ public class DialogflowAgentSummaryEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DialogflowAgentSummary]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DialogflowAgentSummary]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -13378,23 +13465,23 @@ public class DialogflowCXAgentSummaryEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DialogflowCXAgentSummary]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DialogflowCXAgentSummary]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -14503,23 +14590,23 @@ public class DomainEntityListingEvaluationForm: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EvaluationForm]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EvaluationForm]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16281,23 +16368,23 @@ public class EvaluatorActivityEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EvaluatorActivity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EvaluatorActivity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16682,24 +16769,24 @@ public class ExtensionEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Extension]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Extension]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16739,24 +16826,24 @@ public class ExtensionPoolEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ExtensionPool]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ExtensionPool]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -17549,24 +17636,24 @@ public class ExternalOrganizationListing: Codable { public var pageNumber: Int? public var total: Int64? public var partialResults: Bool? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ExternalOrganization]?, pageSize: Int?, pageNumber: Int?, total: Int64?, partialResults: Bool?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ExternalOrganization]?, pageSize: Int?, pageNumber: Int?, total: Int64?, partialResults: Bool?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.partialResults = partialResults - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -17813,23 +17900,23 @@ public class FileSpecificationTemplateEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FileSpecificationTemplate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FileSpecificationTemplate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18497,23 +18584,23 @@ public class FlowResultEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FlowExecutionDataQueryResult]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FlowExecutionDataQueryResult]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -20338,23 +20425,23 @@ public class InteractionStatsAlertContainer: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [InteractionStatsAlert]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [InteractionStatsAlert]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -21230,23 +21317,23 @@ public class JourneyViewListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [JourneyView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [JourneyView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -23355,24 +23442,24 @@ public class LineEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Line]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Line]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -23736,23 +23823,23 @@ public class LogicalInterfaceEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DomainLogicalInterface]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DomainLogicalInterface]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -23790,6 +23877,33 @@ public class Manager: Codable { +public class MaskingRuleValidateResponse: Codable { + + + + + + + + /** is masking rule definition valid? */ + public var valid: Bool? + /** Validation message. */ + public var validationMessage: String? + /** Masked text. */ + public var maskedText: String? + + public init(valid: Bool?, validationMessage: String?, maskedText: String?) { + self.valid = valid + self.validationMessage = validationMessage + self.maskedText = maskedText + } + + +} + + + + public class MatchShiftTradeRequest: Codable { @@ -24502,23 +24616,23 @@ public class MessagingConfigListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [MessagingSetting]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [MessagingSetting]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -24554,23 +24668,23 @@ public class MessagingIntegrationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [MessagingIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [MessagingIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -27198,6 +27312,70 @@ public class PerformanceProfile: Codable { +public class PersistentConnectionChangeTopicErrorInfo: Codable { + + + + + + + + + + + + public var text: String? + public var code: String? + public var userMessage: String? + public var userParams: [String:String]? + public var nestedErrorDetails: [PersistentConnectionChangeTopicErrorInfoDetails]? + + public init(text: String?, code: String?, userMessage: String?, userParams: [String:String]?, nestedErrorDetails: [PersistentConnectionChangeTopicErrorInfoDetails]?) { + self.text = text + self.code = code + self.userMessage = userMessage + self.userParams = userParams + self.nestedErrorDetails = nestedErrorDetails + } + + +} + + + + +public class PersistentConnectionChangeTopicErrorInfoDetails: Codable { + + + + + + + + + + + + public var code: String? + public var userMessage: String? + public var userParams: [String:String]? + public var hostname: String? + public var location: PersistentConnectionChangeTopicErrorLocation? + + public init(code: String?, userMessage: String?, userParams: [String:String]?, hostname: String?, location: PersistentConnectionChangeTopicErrorLocation?) { + self.code = code + self.userMessage = userMessage + self.userParams = userParams + self.hostname = hostname + self.location = location + } + + +} + + + + public class PhoneBaseSettings: Codable { @@ -27328,23 +27506,23 @@ public class PhysicalInterfaceEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DomainPhysicalInterface]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DomainPhysicalInterface]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -27852,23 +28030,23 @@ public class PromptEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Prompt]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Prompt]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -29750,6 +29928,58 @@ public class QueueConversationVideoEventTopicJourneyAction: Codable { + +public class QueueEntityListing: Codable { + + + + + + + + + + + + + + + + + + + + + + public var entities: [Queue]? + public var pageSize: Int? + public var pageNumber: Int? + public var total: Int64? + public var firstUri: String? + public var lastUri: String? + public var selfUri: String? + public var nextUri: String? + public var previousUri: String? + public var pageCount: Int? + + public init(entities: [Queue]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { + self.entities = entities + self.pageSize = pageSize + self.pageNumber = pageNumber + self.total = total + self.firstUri = firstUri + self.lastUri = lastUri + self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri + self.pageCount = pageCount + } + + +} + + + /** A subset of the Journey System's data relevant to a part of a conversation (for external linkage and internal usage/context). */ public class QueueConversationVideoEventTopicJourneyContext: Codable { @@ -30448,58 +30678,6 @@ public class QueueConversationVideoEventTopicWrapup: Codable { -public class QueueEntityListing: Codable { - - - - - - - - - - - - - - - - - - - - - - public var entities: [Queue]? - public var pageSize: Int? - public var pageNumber: Int? - public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? - public var firstUri: String? - public var selfUri: String? - public var pageCount: Int? - - public init(entities: [Queue]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { - self.entities = entities - self.pageSize = pageSize - self.pageNumber = pageNumber - self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri - self.firstUri = firstUri - self.selfUri = selfUri - self.pageCount = pageCount - } - - -} - - - - public class QueueMemberEntityListing: Codable { @@ -30519,19 +30697,19 @@ public class QueueMemberEntityListing: Codable { public var entities: [QueueMember]? public var pageNumber: Int? public var pageSize: Int? - public var nextUri: String? - public var previousUri: String? public var firstUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? - public init(entities: [QueueMember]?, pageNumber: Int?, pageSize: Int?, nextUri: String?, previousUri: String?, firstUri: String?, selfUri: String?) { + public init(entities: [QueueMember]?, pageNumber: Int?, pageSize: Int?, firstUri: String?, selfUri: String?, nextUri: String?, previousUri: String?) { self.entities = entities self.pageNumber = pageNumber self.pageSize = pageSize - self.nextUri = nextUri - self.previousUri = previousUri self.firstUri = firstUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri } @@ -30566,23 +30744,23 @@ public class QueueMemberEntityListingV1: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [QueueMember]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [QueueMember]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -31220,23 +31398,23 @@ public class ReportingExportJobListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ReportingExportJobResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ReportingExportJobResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -32136,23 +32314,23 @@ public class ResponseEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ModelResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ModelResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -32188,23 +32366,23 @@ public class ResponseSetEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ResponseSet]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ResponseSet]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -32997,23 +33175,23 @@ public class SecurityProfileEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SecurityProfile]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SecurityProfile]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -33448,23 +33626,23 @@ public class SmsAddressEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SmsAddress]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SmsAddress]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -34272,23 +34450,23 @@ public class SystemPromptEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SystemPrompt]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SystemPrompt]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -35838,24 +36016,24 @@ public class TrunkEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Trunk]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Trunk]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -36151,23 +36329,23 @@ public class TtsVoiceEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [TtsVoiceEntity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [TtsVoiceEntity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -37055,23 +37233,23 @@ public class UserQueueEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UserQueue]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UserQueue]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -39015,22 +39193,6 @@ public class WfmBuShortTermForecastCopyCompleteTopicBuShortTermForecastNotificat -public class WfmIntegrationListing: Codable { - - - - public var entities: [WfmIntegrationResponse]? - - public init(entities: [WfmIntegrationResponse]?) { - self.entities = entities - } - - -} - - - - public class WfmBuShortTermForecastGenerateProgressTopicBuForecastModification: Codable { public enum ModelType: String, Codable { @@ -39488,6 +39650,22 @@ public class WfmHistoricalShrinkageRequest: Codable { +public class WfmIntegrationListing: Codable { + + + + public var entities: [WfmIntegrationResponse]? + + public init(entities: [WfmIntegrationResponse]?) { + self.entities = entities + } + + +} + + + + public class WfmIntegrationsHrisTimeOffTypesJobTopicErrorBody: Codable { diff --git a/build/src/Models/PlatformAPIModelsP4.swift b/build/src/Models/PlatformAPIModelsP4.swift index cf4503d59..fcd7403b2 100644 --- a/build/src/Models/PlatformAPIModelsP4.swift +++ b/build/src/Models/PlatformAPIModelsP4.swift @@ -2319,23 +2319,23 @@ public class AudioConnectorIntegrationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [AudioConnectorIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [AudioConnectorIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -3636,23 +3636,23 @@ public class CalibrationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Calibration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Calibration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -4235,23 +4235,23 @@ public class CallableTimeSetEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CallableTimeSet]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CallableTimeSet]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -4773,23 +4773,23 @@ public class CampaignRuleEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CampaignRule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CampaignRule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -5645,6 +5645,8 @@ public class CobrowseSettings: Codable { + + public enum Channels: String, Codable { case webmessaging = "Webmessaging" case voice = "Voice" @@ -5660,6 +5662,8 @@ public class CobrowseSettings: Codable { public var allowAgentControl: Bool? /** Whether the viewer should have option to request navigation */ public var allowAgentNavigation: Bool? + /** Should cobrowse draw be enabled */ + public var allowDraw: Bool? /** Mask patterns that will apply to pages being shared */ public var maskSelectors: [String]? /** Cobrowse channels for web messenger */ @@ -5669,10 +5673,11 @@ public class CobrowseSettings: Codable { /** Pause criteria that will pause cobrowse if some of them are met in the user's URL */ public var pauseCriteria: [PauseCriteria]? - public init(enabled: Bool?, allowAgentControl: Bool?, allowAgentNavigation: Bool?, maskSelectors: [String]?, channels: [Channels]?, readonlySelectors: [String]?, pauseCriteria: [PauseCriteria]?) { + public init(enabled: Bool?, allowAgentControl: Bool?, allowAgentNavigation: Bool?, allowDraw: Bool?, maskSelectors: [String]?, channels: [Channels]?, readonlySelectors: [String]?, pauseCriteria: [PauseCriteria]?) { self.enabled = enabled self.allowAgentControl = allowAgentControl self.allowAgentNavigation = allowAgentNavigation + self.allowDraw = allowDraw self.maskSelectors = maskSelectors self.channels = channels self.readonlySelectors = readonlySelectors @@ -6426,6 +6431,134 @@ public class ContactAddressConditionSettings: Codable { +public class ContactImportField: Codable { + + + + + + /** Field name */ + public var name: String? + /** Should we import this field */ + public var included: Bool? + + public init(name: String?, included: Bool?) { + self.name = name + self.included = included + } + + +} + + + + +public class ContactImportJobMetadata: Codable { + + + + + + + + + + + + + + + + public var fileName: String? + public var dryRunFailedCount: Int? + public var dryRunSuccessCount: Int? + public var dryRunReportDownloadUrl: String? + public var importFailedCount: Int? + public var importSuccessCount: Int? + public var importReportDownloadUrl: String? + + public init(fileName: String?, dryRunFailedCount: Int?, dryRunSuccessCount: Int?, dryRunReportDownloadUrl: String?, importFailedCount: Int?, importSuccessCount: Int?, importReportDownloadUrl: String?) { + self.fileName = fileName + self.dryRunFailedCount = dryRunFailedCount + self.dryRunSuccessCount = dryRunSuccessCount + self.dryRunReportDownloadUrl = dryRunReportDownloadUrl + self.importFailedCount = importFailedCount + self.importSuccessCount = importSuccessCount + self.importReportDownloadUrl = importReportDownloadUrl + } + + +} + + + + +public class ContactImportSettings: Codable { + + + + + + public enum MatchingCriteria: String, Codable { + case email = "Email" + case phone = "Phone" + } + + + + + + + + + + + + /** The globally unique identifier for the object. */ + public var _id: String? + /** Display name for the settings */ + public var name: String? + /** Which fields you want to identity resolution based on. (e.g.: Email, Phone). It can be empty, populated only one of them or it can be both for now. The order of the items is important for identity resolution */ + public var matchingCriteria: [MatchingCriteria]? + /** Decides what happens when a record already found in the system. Action will be Upsert or Merge */ + public var mergeContacts: Bool? + /** Define the corresponding source system by the customer, the customer can have different externalId source, they can collect this id from contact service */ + public var externalSourceId: String? + /** Decides which field we need to send towards contact service */ + public var importFields: [ContactImportField]? + /** Creation date for the settings. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateCreated: Date? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, name: String?, matchingCriteria: [MatchingCriteria]?, mergeContacts: Bool?, externalSourceId: String?, importFields: [ContactImportField]?, dateCreated: Date?, selfUri: String?) { + self._id = _id + self.name = name + self.matchingCriteria = matchingCriteria + self.mergeContacts = mergeContacts + self.externalSourceId = externalSourceId + self.importFields = importFields + self.dateCreated = dateCreated + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case matchingCriteria + case mergeContacts + case externalSourceId + case importFields + case dateCreated + case selfUri + } + + +} + + + + public class ContactListEntityListing: Codable { @@ -6452,23 +6585,23 @@ public class ContactListEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ContactList]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ContactList]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -7459,7 +7592,7 @@ public class ConversationCallEventTopicUriReference: Codable { -public class ConversationCallbackEventTopicDivisionEntityRef: Codable { +public class Copilot: Codable { @@ -7467,21 +7600,59 @@ public class ConversationCallbackEventTopicDivisionEntityRef: Codable { - public var _id: String? - public var selfUri: String? - /** The time the entity division was last updated. */ - public var dateDivisionUpdated: Date? - public init(_id: String?, selfUri: String?, dateDivisionUpdated: Date?) { - self._id = _id - self.selfUri = selfUri - self.dateDivisionUpdated = dateDivisionUpdated + + + + + + + + public enum NluEngineType: String, Codable { + case nluV3 = "NluV3" } - public enum CodingKeys: String, CodingKey { - case _id = "id" - case selfUri - case dateDivisionUpdated + + + + + + + /** Copilot is enabled. */ + public var enabled: Bool? + /** Copilot is live on selected queue. */ + public var liveOnQueue: Bool? + /** Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified. */ + public var defaultLanguage: String? + /** Knowledge answer configuration. */ + public var knowledgeAnswerConfig: KnowledgeAnswerConfig? + /** Copilot generated summary configuration. */ + public var summaryGenerationConfig: SummaryGenerationConfig? + /** Copilot generated wrapup code prediction configuration. */ + public var wrapupCodePredictionConfig: WrapupCodePredictionConfig? + /** Answer generation configuration. */ + public var answerGenerationConfig: AnswerGenerationConfig? + /** Language understanding engine type. */ + public var nluEngineType: NluEngineType? + /** NLU configuration. */ + public var nluConfig: NluConfig? + /** Rule engine configuration. */ + public var ruleEngineConfig: RuleEngineConfig? + /** The URI for this object */ + public var selfUri: String? + + public init(enabled: Bool?, liveOnQueue: Bool?, defaultLanguage: String?, knowledgeAnswerConfig: KnowledgeAnswerConfig?, summaryGenerationConfig: SummaryGenerationConfig?, wrapupCodePredictionConfig: WrapupCodePredictionConfig?, answerGenerationConfig: AnswerGenerationConfig?, nluEngineType: NluEngineType?, nluConfig: NluConfig?, ruleEngineConfig: RuleEngineConfig?, selfUri: String?) { + self.enabled = enabled + self.liveOnQueue = liveOnQueue + self.defaultLanguage = defaultLanguage + self.knowledgeAnswerConfig = knowledgeAnswerConfig + self.summaryGenerationConfig = summaryGenerationConfig + self.wrapupCodePredictionConfig = wrapupCodePredictionConfig + self.answerGenerationConfig = answerGenerationConfig + self.nluEngineType = nluEngineType + self.nluConfig = nluConfig + self.ruleEngineConfig = ruleEngineConfig + self.selfUri = selfUri } @@ -7489,26 +7660,30 @@ public class ConversationCallbackEventTopicDivisionEntityRef: Codable { -/** A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context) */ -public class ConversationCallbackEventTopicJourneyAction: Codable { +public class ConversationCallbackEventTopicDivisionEntityRef: Codable { + + - /** The ID of an action from the Journey System (an action is spawned from an actionMap) */ public var _id: String? - public var actionMap: ConversationCallbackEventTopicJourneyActionMap? + public var selfUri: String? + /** The time the entity division was last updated. */ + public var dateDivisionUpdated: Date? - public init(_id: String?, actionMap: ConversationCallbackEventTopicJourneyActionMap?) { + public init(_id: String?, selfUri: String?, dateDivisionUpdated: Date?) { self._id = _id - self.actionMap = actionMap + self.selfUri = selfUri + self.dateDivisionUpdated = dateDivisionUpdated } public enum CodingKeys: String, CodingKey { case _id = "id" - case actionMap + case selfUri + case dateDivisionUpdated } @@ -7516,48 +7691,26 @@ public class ConversationCallbackEventTopicJourneyAction: Codable { +/** A subset of the Journey System's action data relevant to a part of a conversation (for external linkage and internal usage/context) */ -public class ConversationCategory: Codable { - - - - +public class ConversationCallbackEventTopicJourneyAction: Codable { - public enum InteractionType: String, Codable { - case voice = "Voice" - case digital = "Digital" - case all = "All" - } - - /** The id of the category */ + /** The ID of an action from the Journey System (an action is spawned from an actionMap) */ public var _id: String? - /** The name of the category */ - public var name: String? - /** The description of the category */ - public var _description: String? - /** The type of interaction the category will apply to */ - public var interactionType: InteractionType? - /** A collection of conditions joined together by logical operation to provide more refined filtering of conversations */ - public var criteria: Operand? + public var actionMap: ConversationCallbackEventTopicJourneyActionMap? - public init(_id: String?, name: String?, _description: String?, interactionType: InteractionType?, criteria: Operand?) { + public init(_id: String?, actionMap: ConversationCallbackEventTopicJourneyActionMap?) { self._id = _id - self.name = name - self._description = _description - self.interactionType = interactionType - self.criteria = criteria + self.actionMap = actionMap } public enum CodingKeys: String, CodingKey { case _id = "id" - case name - case _description = "description" - case interactionType - case criteria + case actionMap } @@ -7627,6 +7780,55 @@ public class ConversationCallbackEventTopicWrapup: Codable { +public class ConversationCategory: Codable { + + + + + + + + public enum InteractionType: String, Codable { + case voice = "Voice" + case digital = "Digital" + case all = "All" + } + + + + /** The id of the category */ + public var _id: String? + /** The name of the category */ + public var name: String? + /** The description of the category */ + public var _description: String? + /** The type of interaction the category will apply to */ + public var interactionType: InteractionType? + /** A collection of conditions joined together by logical operation to provide more refined filtering of conversations */ + public var criteria: Operand? + + public init(_id: String?, name: String?, _description: String?, interactionType: InteractionType?, criteria: Operand?) { + self._id = _id + self.name = name + self._description = _description + self.interactionType = interactionType + self.criteria = criteria + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case _description = "description" + case interactionType + case criteria + } + + +} + + + + public class ConversationChatEventTopicLimit: Codable { @@ -7907,6 +8109,29 @@ public class ConversationContentCardAction: Codable { +/** A datetimepicker available time that a user can take. */ + +public class ConversationContentDatePickerAvailableTime: Codable { + + + + + + /** The duration of the scheduling event in seconds. */ + public var duration: Int64? + /** The date and time of the event being scheduled. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateTime: Date? + + public init(duration: Int64?, dateTime: Date?) { + self.duration = duration + self.dateTime = dateTime + } + + +} + + + /** Quick reply object V2. */ public class ConversationContentQuickReplyV2: Codable { @@ -8701,75 +8926,6 @@ public class ConversationEventTopicSocialExpression: Codable { - -public class Copilot: Codable { - - - - - - - - - - - - - - - - public enum NluEngineType: String, Codable { - case nluV3 = "NluV3" - } - - - - - - - - /** Copilot is enabled. */ - public var enabled: Bool? - /** Copilot is live on selected queue. */ - public var liveOnQueue: Bool? - /** Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified. */ - public var defaultLanguage: String? - /** Knowledge answer configuration. */ - public var knowledgeAnswerConfig: KnowledgeAnswerConfig? - /** Copilot generated summary configuration. */ - public var summaryGenerationConfig: SummaryGenerationConfig? - /** Copilot generated wrapup code prediction configuration. */ - public var wrapupCodePredictionConfig: WrapupCodePredictionConfig? - /** Answer generation configuration. */ - public var answerGenerationConfig: AnswerGenerationConfig? - /** Language understanding engine type. */ - public var nluEngineType: NluEngineType? - /** NLU configuration. */ - public var nluConfig: NluConfig? - /** Rule engine configuration. */ - public var ruleEngineConfig: RuleEngineConfig? - /** The URI for this object */ - public var selfUri: String? - - public init(enabled: Bool?, liveOnQueue: Bool?, defaultLanguage: String?, knowledgeAnswerConfig: KnowledgeAnswerConfig?, summaryGenerationConfig: SummaryGenerationConfig?, wrapupCodePredictionConfig: WrapupCodePredictionConfig?, answerGenerationConfig: AnswerGenerationConfig?, nluEngineType: NluEngineType?, nluConfig: NluConfig?, ruleEngineConfig: RuleEngineConfig?, selfUri: String?) { - self.enabled = enabled - self.liveOnQueue = liveOnQueue - self.defaultLanguage = defaultLanguage - self.knowledgeAnswerConfig = knowledgeAnswerConfig - self.summaryGenerationConfig = summaryGenerationConfig - self.wrapupCodePredictionConfig = wrapupCodePredictionConfig - self.answerGenerationConfig = answerGenerationConfig - self.nluEngineType = nluEngineType - self.nluConfig = nluConfig - self.ruleEngineConfig = ruleEngineConfig - self.selfUri = selfUri - } - - -} - - - /** Fields identifying the entity that updated the command. */ public class ConversationEventTopicTransferModifedBy: Codable { @@ -8843,6 +8999,7 @@ public class ConversationMessageContent: Codable { case carousel = "Carousel" case text = "Text" case quickReplyV2 = "QuickReplyV2" + case datePicker = "DatePicker" case unknown = "Unknown" } @@ -9140,113 +9297,6 @@ public class ConversationScreenShareEventTopicConversationDivisionMembership: Co - -public class ConversationSummary: Codable { - - - - public enum Status: String, Codable { - case pending = "Pending" - case queued = "Queued" - case started = "Started" - case completed = "Completed" - case error = "Error" - case processing = "Processing" - } - - public enum MediaType: String, Codable { - case email = "Email" - case call = "Call" - case chat = "Chat" - case message = "Message" - case webmessaging = "Webmessaging" - case unknown = "Unknown" - } - - - - - - - - - - - - - - - - - - - - - - /** The text of the summary. */ - public var text: String? - /** The status of the conversation summary. */ - public var status: Status? - /** The media type of the conversation. */ - public var mediaType: MediaType? - /** The language of the conversation. */ - public var language: String? - /** The wrapup codes of the conversation summary. */ - public var predictedWrapupCodes: [ConversationSummaryWrapupCode]? - /** The edited summary of the conversation. */ - public var editedSummary: ConversationEditedSummary? - /** The reason of the conversation summary. */ - public var reason: ConversationSummaryReason? - /** The followup of the conversation summary. */ - public var followup: ConversationSummaryFollowup? - /** The resolution of the conversation summary. */ - public var resolution: ConversationSummaryResolution? - /** The created date of the summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ - public var dateCreated: Date? - /** The id of the summary. */ - public var _id: String? - /** The AI confidence value. */ - public var confidence: Float? - /** The list of participants. */ - public var participants: [AddressableEntityRef]? - - public init(text: String?, status: Status?, mediaType: MediaType?, language: String?, predictedWrapupCodes: [ConversationSummaryWrapupCode]?, editedSummary: ConversationEditedSummary?, reason: ConversationSummaryReason?, followup: ConversationSummaryFollowup?, resolution: ConversationSummaryResolution?, dateCreated: Date?, _id: String?, confidence: Float?, participants: [AddressableEntityRef]?) { - self.text = text - self.status = status - self.mediaType = mediaType - self.language = language - self.predictedWrapupCodes = predictedWrapupCodes - self.editedSummary = editedSummary - self.reason = reason - self.followup = followup - self.resolution = resolution - self.dateCreated = dateCreated - self._id = _id - self.confidence = confidence - self.participants = participants - } - - public enum CodingKeys: String, CodingKey { - case text - case status - case mediaType - case language - case predictedWrapupCodes - case editedSummary - case reason - case followup - case resolution - case dateCreated - case _id = "id" - case confidence - case participants - } - - -} - - - /** A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context) */ public class ConversationScreenShareEventTopicJourneyCustomer: Codable { @@ -9888,6 +9938,113 @@ public class ConversationSummariesGetResponse: Codable { +public class ConversationSummary: Codable { + + + + public enum Status: String, Codable { + case pending = "Pending" + case queued = "Queued" + case started = "Started" + case completed = "Completed" + case error = "Error" + case processing = "Processing" + } + + public enum MediaType: String, Codable { + case email = "Email" + case call = "Call" + case chat = "Chat" + case message = "Message" + case webmessaging = "Webmessaging" + case unknown = "Unknown" + } + + + + + + + + + + + + + + + + + + + + + + /** The text of the summary. */ + public var text: String? + /** The status of the conversation summary. */ + public var status: Status? + /** The media type of the conversation. */ + public var mediaType: MediaType? + /** The language of the conversation. */ + public var language: String? + /** The wrapup codes of the conversation summary. */ + public var predictedWrapupCodes: [ConversationSummaryWrapupCode]? + /** The edited summary of the conversation. */ + public var editedSummary: ConversationEditedSummary? + /** The reason of the conversation summary. */ + public var reason: ConversationSummaryReason? + /** The followup of the conversation summary. */ + public var followup: ConversationSummaryFollowup? + /** The resolution of the conversation summary. */ + public var resolution: ConversationSummaryResolution? + /** The created date of the summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateCreated: Date? + /** The id of the summary. */ + public var _id: String? + /** The AI confidence value. */ + public var confidence: Float? + /** The list of participants. */ + public var participants: [AddressableEntityRef]? + + public init(text: String?, status: Status?, mediaType: MediaType?, language: String?, predictedWrapupCodes: [ConversationSummaryWrapupCode]?, editedSummary: ConversationEditedSummary?, reason: ConversationSummaryReason?, followup: ConversationSummaryFollowup?, resolution: ConversationSummaryResolution?, dateCreated: Date?, _id: String?, confidence: Float?, participants: [AddressableEntityRef]?) { + self.text = text + self.status = status + self.mediaType = mediaType + self.language = language + self.predictedWrapupCodes = predictedWrapupCodes + self.editedSummary = editedSummary + self.reason = reason + self.followup = followup + self.resolution = resolution + self.dateCreated = dateCreated + self._id = _id + self.confidence = confidence + self.participants = participants + } + + public enum CodingKeys: String, CodingKey { + case text + case status + case mediaType + case language + case predictedWrapupCodes + case editedSummary + case reason + case followup + case resolution + case dateCreated + case _id = "id" + case confidence + case participants + } + + +} + + + + public class ConversationSummaryTopicVirtualAgentsConversationReason: Codable { @@ -10031,6 +10188,34 @@ public class ConversationTagsUpdate: Codable { +public class Detail: Codable { + + + + + + + + + + public var errorCode: String? + public var fieldName: String? + public var entityId: String? + public var entityName: String? + + public init(errorCode: String?, fieldName: String?, entityId: String?, entityName: String?) { + self.errorCode = errorCode + self.fieldName = fieldName + self.entityId = entityId + self.entityName = entityName + } + + +} + + + + public class ConversationThreadingWindow: Codable { @@ -11228,34 +11413,6 @@ public class CredentialInfo: Codable { -public class Detail: Codable { - - - - - - - - - - public var errorCode: String? - public var fieldName: String? - public var entityId: String? - public var entityName: String? - - public init(errorCode: String?, fieldName: String?, entityId: String?, entityName: String?) { - self.errorCode = errorCode - self.fieldName = fieldName - self.entityId = entityId - self.entityName = entityName - } - - -} - - - - public class CredentialInfoListing: Codable { @@ -11282,23 +11439,23 @@ public class CredentialInfoListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CredentialInfo]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CredentialInfo]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -11519,23 +11676,23 @@ public class DataTableRowEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [[String:JSON]]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [[String:JSON]]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -11870,23 +12027,23 @@ public class DevelopmentActivityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DevelopmentActivity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DevelopmentActivity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12398,24 +12555,24 @@ public class DivsPermittedEntityListing: Codable { public var pageNumber: Int? public var total: Int64? public var allDivsPermitted: Bool? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [AuthzDivision]?, pageSize: Int?, pageNumber: Int?, total: Int64?, allDivsPermitted: Bool?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [AuthzDivision]?, pageSize: Int?, pageNumber: Int?, total: Int64?, allDivsPermitted: Bool?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.allDivsPermitted = allDivsPermitted - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12901,23 +13058,23 @@ public class DomainEdgeSoftwareVersionDtoEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DomainEdgeSoftwareVersionDto]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DomainEdgeSoftwareVersionDto]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12953,23 +13110,23 @@ public class DomainEntityListingQueryResult: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [QueryResult]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [QueryResult]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -13005,23 +13162,23 @@ public class DomainEntityListingSurveyForm: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SurveyForm]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SurveyForm]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -13189,24 +13346,24 @@ public class EdgeEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Edge]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Edge]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -13246,24 +13403,24 @@ public class EdgeGroupEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EdgeGroup]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EdgeGroup]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -13672,23 +13829,23 @@ public class EmailConversationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EmailConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EmailConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -13967,23 +14124,23 @@ public class EmailMessagePreviewListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EmailMessagePreview]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EmailMessagePreview]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -14541,23 +14698,23 @@ public class EvaluationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Evaluation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Evaluation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -15726,23 +15883,23 @@ public class ExternalMetricDefinitionListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ExternalMetricDefinition]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ExternalMetricDefinition]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16163,23 +16320,23 @@ public class FaxDocumentEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FaxDocument]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FaxDocument]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16549,23 +16706,23 @@ public class FlowEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Flow]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Flow]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16883,23 +17040,23 @@ public class FlowOutcomeDivisionViewEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FlowOutcomeDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FlowOutcomeDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16935,23 +17092,23 @@ public class FlowOutcomeListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FlowOutcome]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FlowOutcome]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18281,23 +18438,23 @@ public class ImportTemplateEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ImportTemplate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ImportTemplate]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18923,33 +19080,6 @@ public class JourneyAggregateQueryClause: Codable { -public class Label: Codable { - - - - - - - - /** Name of the label */ - public var name: String? - /** Value of the label */ - public var value: String? - /** Whether the label is encoded or not */ - public var encoded: Bool? - - public init(name: String?, value: String?, encoded: Bool?) { - self.name = name - self.value = value - self.encoded = encoded - } - - -} - - - - public class JourneyAggregationQuery: Codable { @@ -20078,44 +20208,6 @@ public class JourneyWebEventsNotificationOutcome: Codable { -public class LexBot: Codable { - - - - - - - - - - /** The globally unique identifier for the object. */ - public var _id: String? - public var name: String? - /** A description of the Lex bot */ - public var _description: String? - /** The URI for this object */ - public var selfUri: String? - - public init(_id: String?, name: String?, _description: String?, selfUri: String?) { - self._id = _id - self.name = name - self._description = _description - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - case _description = "description" - case selfUri - } - - -} - - - - public class JsonNodeSearchResponse: Codable { @@ -21831,6 +21923,33 @@ public class KnowledgeSyncJobReport: Codable { +public class Label: Codable { + + + + + + + + /** Name of the label */ + public var name: String? + /** Value of the label */ + public var value: String? + /** Whether the label is encoded or not */ + public var encoded: Bool? + + public init(name: String?, value: String?, encoded: Bool?) { + self.name = name + self.value = value + self.encoded = encoded + } + + +} + + + + public class LabelListing: Codable { @@ -22080,117 +22199,6 @@ public class LearningAssignment: Codable { - -public class LearningAssignmentAggregateParam: Codable { - - - - public enum Metrics: String, Codable { - case nactivities = "nActivities" - case nplannedactivities = "nPlannedActivities" - case ninprogressactivities = "nInProgressActivities" - case ncompleteactivities = "nCompleteActivities" - case noverdueactivities = "nOverdueActivities" - case ninvalidscheduleactivities = "nInvalidScheduleActivities" - case npassedactivities = "nPassedActivities" - case nfailedactivities = "nFailedActivities" - case oactivityscore = "oActivityScore" - case nnotcompletedactivities = "nNotCompletedActivities" - } - - public enum GroupBy: String, Codable { - case attendeeid = "attendeeId" - } - - - - /** 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 */ - public var interval: String? - /** The list of metrics to be returned. If omitted, all metrics are returned. */ - public var metrics: [Metrics]? - /** 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\") */ - public var groupBy: [GroupBy]? - /** The filter applied to the data. This is ANDed with the interval parameter. */ - public var filter: LearningAssignmentAggregateQueryRequestFilter? - - public init(interval: String?, metrics: [Metrics]?, groupBy: [GroupBy]?, filter: LearningAssignmentAggregateQueryRequestFilter?) { - self.interval = interval - self.metrics = metrics - self.groupBy = groupBy - self.filter = filter - } - - -} - - - - -public class LearningAssignmentAggregateQueryRequestPredicate: Codable { - - public enum Dimension: String, Codable { - case attendeeid = "attendeeId" - case type = "type" - case moduleid = "moduleId" - case ispassed = "isPassed" - } - - - - /** Each predicates specifies a dimension. */ - public var dimension: Dimension? - /** Corresponding value for dimensions in predicates. If the dimension is type, Valid Values: Informational (deprecated), AssessedContent (deprecated), Assessment (deprecated), External, Native */ - public var value: String? - - public init(dimension: Dimension?, value: String?) { - self.dimension = dimension - self.value = value - } - - -} - - - - -public class LearningAssignmentAggregateResponse: Codable { - - - - /** The results of the query */ - public var results: [LearningAssignmentAggregateQueryResponseGroupedData]? - - public init(results: [LearningAssignmentAggregateQueryResponseGroupedData]?) { - self.results = results - } - - -} - - - - -public class LearningAssignmentBulkAddResponse: Codable { - - - - - - /** The learning assignments that were assigned correctly */ - public var entities: [LearningAssignment]? - /** The items that were not allowed to be assigned */ - public var disallowedEntities: [DisallowedEntityLearningAssignmentItem]? - - public init(entities: [LearningAssignment]?, disallowedEntities: [DisallowedEntityLearningAssignmentItem]?) { - self.entities = entities - self.disallowedEntities = disallowedEntities - } - - -} - - - /** Learning module response */ public class LearningModule: Codable { @@ -22376,6 +22384,117 @@ public class LearningModule: Codable { +public class LearningAssignmentAggregateParam: Codable { + + + + public enum Metrics: String, Codable { + case nactivities = "nActivities" + case nplannedactivities = "nPlannedActivities" + case ninprogressactivities = "nInProgressActivities" + case ncompleteactivities = "nCompleteActivities" + case noverdueactivities = "nOverdueActivities" + case ninvalidscheduleactivities = "nInvalidScheduleActivities" + case npassedactivities = "nPassedActivities" + case nfailedactivities = "nFailedActivities" + case oactivityscore = "oActivityScore" + case nnotcompletedactivities = "nNotCompletedActivities" + } + + public enum GroupBy: String, Codable { + case attendeeid = "attendeeId" + } + + + + /** 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 */ + public var interval: String? + /** The list of metrics to be returned. If omitted, all metrics are returned. */ + public var metrics: [Metrics]? + /** 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\") */ + public var groupBy: [GroupBy]? + /** The filter applied to the data. This is ANDed with the interval parameter. */ + public var filter: LearningAssignmentAggregateQueryRequestFilter? + + public init(interval: String?, metrics: [Metrics]?, groupBy: [GroupBy]?, filter: LearningAssignmentAggregateQueryRequestFilter?) { + self.interval = interval + self.metrics = metrics + self.groupBy = groupBy + self.filter = filter + } + + +} + + + + +public class LearningAssignmentAggregateQueryRequestPredicate: Codable { + + public enum Dimension: String, Codable { + case attendeeid = "attendeeId" + case type = "type" + case moduleid = "moduleId" + case ispassed = "isPassed" + } + + + + /** Each predicates specifies a dimension. */ + public var dimension: Dimension? + /** Corresponding value for dimensions in predicates. If the dimension is type, Valid Values: Informational (deprecated), AssessedContent (deprecated), Assessment (deprecated), External, Native */ + public var value: String? + + public init(dimension: Dimension?, value: String?) { + self.dimension = dimension + self.value = value + } + + +} + + + + +public class LearningAssignmentAggregateResponse: Codable { + + + + /** The results of the query */ + public var results: [LearningAssignmentAggregateQueryResponseGroupedData]? + + public init(results: [LearningAssignmentAggregateQueryResponseGroupedData]?) { + self.results = results + } + + +} + + + + +public class LearningAssignmentBulkAddResponse: Codable { + + + + + + /** The learning assignments that were assigned correctly */ + public var entities: [LearningAssignment]? + /** The items that were not allowed to be assigned */ + public var disallowedEntities: [DisallowedEntityLearningAssignmentItem]? + + public init(entities: [LearningAssignment]?, disallowedEntities: [DisallowedEntityLearningAssignmentItem]?) { + self.entities = entities + self.disallowedEntities = disallowedEntities + } + + +} + + + + public class LearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification: Codable { @@ -22460,24 +22579,24 @@ public class LearningAssignmentUserListing: Codable { public var total: Int64? /** The total number of users */ public var unfilteredTotal: Int? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [LearningAssignmentUser]?, pageSize: Int?, pageNumber: Int?, total: Int64?, unfilteredTotal: Int?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [LearningAssignmentUser]?, pageSize: Int?, pageNumber: Int?, total: Int64?, unfilteredTotal: Int?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.unfilteredTotal = unfilteredTotal - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -22960,6 +23079,44 @@ public class LearningSlotWfmScheduleActivity: Codable { +public class LexBot: Codable { + + + + + + + + + + /** The globally unique identifier for the object. */ + public var _id: String? + public var name: String? + /** A description of the Lex bot */ + public var _description: String? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, name: String?, _description: String?, selfUri: String?) { + self._id = _id + self.name = name + self._description = _description + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case _description = "description" + case selfUri + } + + +} + + + + public class LexBotAlias: Codable { @@ -25085,256 +25242,256 @@ public class NluDomainVersionListing: Codable { - public var entities: [NluDomainVersion]? - public var pageSize: Int? - public var pageNumber: Int? - public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? - public var firstUri: String? - public var selfUri: String? - public var pageCount: Int? - - public init(entities: [NluDomainVersion]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { - self.entities = entities - self.pageSize = pageSize - self.pageNumber = pageNumber - self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri - self.firstUri = firstUri - self.selfUri = selfUri - self.pageCount = pageCount - } - - -} - - - - -public class NluDomainVersionTrainingResponse: Codable { - - - - - - /** A message indicating result of the action. */ - public var message: String? - public var version: NluDomainVersion? - - public init(message: String?, version: NluDomainVersion?) { - self.message = message - self.version = version - } - - -} - - - - -public class NluUtteranceSegment: Codable { - - - - - - /** The text of the segment. */ - public var text: String? - /** The entity annotation of the segment. */ - public var entity: NamedEntityAnnotation? - - public init(text: String?, entity: NamedEntityAnnotation?) { - self.text = text - self.entity = entity - } - - -} - - - -/** Model for a Nuance bot */ - -public class NuanceBot: Codable { - - - - - - - - - - - - - - - - - - - - - - - - - - - - /** Nuance bot Id */ - public var _id: String? - /** Nuance bot name */ - public var name: String? - /** The Integration Id for this bot */ - public var integrationId: String? - /** The Nuance Organization for this bot */ - public var nuanceOrganization: NuanceOrganization? - /** The Application for this bot */ - public var application: NuanceApplication? - /** The environment of the Nuance bot */ - public var nuanceEnvironment: NuanceEnvironment? - /** The Geography of the Nuance bot */ - public var geography: NuanceGeography? - /** client ID/Secret objects for the credentials that execute this Nuance bot */ - public var credentials: [NuanceBotCredentials]? - /** List of available variables in this Nuance bot. When querying, use the 'expand=variables' query param to populate this value */ - public var variables: [NuanceBotVariable]? - /** List of transferNodes in this Nuance bot. When querying, use the 'expand=transferNodes' query param to populate this value */ - public var transferNodes: [NuanceBotTransferNode]? - /** List of locales associated with this Nuance bot. Generally in the ISO format such as 'en-US' */ - public var locales: [String]? - /** List of channels associated with this Nuance bot. */ - public var channels: [NuanceChannel]? - /** The URI for this object */ - public var selfUri: String? - - public init(_id: String?, name: String?, integrationId: String?, nuanceOrganization: NuanceOrganization?, application: NuanceApplication?, nuanceEnvironment: NuanceEnvironment?, geography: NuanceGeography?, credentials: [NuanceBotCredentials]?, variables: [NuanceBotVariable]?, transferNodes: [NuanceBotTransferNode]?, locales: [String]?, channels: [NuanceChannel]?, selfUri: String?) { - self._id = _id - self.name = name - self.integrationId = integrationId - self.nuanceOrganization = nuanceOrganization - self.application = application - self.nuanceEnvironment = nuanceEnvironment - self.geography = geography - self.credentials = credentials - self.variables = variables - self.transferNodes = transferNodes - self.locales = locales - self.channels = channels - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - case integrationId - case nuanceOrganization - case application - case nuanceEnvironment - case geography - case credentials - case variables - case transferNodes - case locales - case channels - case selfUri - } - - -} - - - -/** Model for a Nuance bot environment */ - -public class NuanceEnvironment: Codable { - - - - - - - - - - /** The environment ID */ - public var _id: String? - /** The environment name */ - public var name: String? - /** The environment type, usually a value like SANDBOX or PRODUCTION */ - public var environmentDesignation: String? - /** The host used to execute this bot, similar to 'api.nuance.com:443' */ - public var executionHost: String? - - public init(_id: String?, name: String?, environmentDesignation: String?, executionHost: String?) { - self._id = _id - self.name = name - self.environmentDesignation = environmentDesignation - self.executionHost = executionHost - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - case environmentDesignation - case executionHost - } - - -} - - - - -public class OAuthClientEntityListing: Codable { - - - - - - - - - - - - - - - - - - - - - - public var entities: [OAuthClientListing]? + public var entities: [NluDomainVersion]? public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [OAuthClientListing]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [NluDomainVersion]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total + self.firstUri = firstUri + self.lastUri = lastUri + self.selfUri = selfUri self.nextUri = nextUri self.previousUri = previousUri - self.lastUri = lastUri + self.pageCount = pageCount + } + + +} + + + + +public class NluDomainVersionTrainingResponse: Codable { + + + + + + /** A message indicating result of the action. */ + public var message: String? + public var version: NluDomainVersion? + + public init(message: String?, version: NluDomainVersion?) { + self.message = message + self.version = version + } + + +} + + + + +public class NluUtteranceSegment: Codable { + + + + + + /** The text of the segment. */ + public var text: String? + /** The entity annotation of the segment. */ + public var entity: NamedEntityAnnotation? + + public init(text: String?, entity: NamedEntityAnnotation?) { + self.text = text + self.entity = entity + } + + +} + + + +/** Model for a Nuance bot */ + +public class NuanceBot: Codable { + + + + + + + + + + + + + + + + + + + + + + + + + + + + /** Nuance bot Id */ + public var _id: String? + /** Nuance bot name */ + public var name: String? + /** The Integration Id for this bot */ + public var integrationId: String? + /** The Nuance Organization for this bot */ + public var nuanceOrganization: NuanceOrganization? + /** The Application for this bot */ + public var application: NuanceApplication? + /** The environment of the Nuance bot */ + public var nuanceEnvironment: NuanceEnvironment? + /** The Geography of the Nuance bot */ + public var geography: NuanceGeography? + /** client ID/Secret objects for the credentials that execute this Nuance bot */ + public var credentials: [NuanceBotCredentials]? + /** List of available variables in this Nuance bot. When querying, use the 'expand=variables' query param to populate this value */ + public var variables: [NuanceBotVariable]? + /** List of transferNodes in this Nuance bot. When querying, use the 'expand=transferNodes' query param to populate this value */ + public var transferNodes: [NuanceBotTransferNode]? + /** List of locales associated with this Nuance bot. Generally in the ISO format such as 'en-US' */ + public var locales: [String]? + /** List of channels associated with this Nuance bot. */ + public var channels: [NuanceChannel]? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, name: String?, integrationId: String?, nuanceOrganization: NuanceOrganization?, application: NuanceApplication?, nuanceEnvironment: NuanceEnvironment?, geography: NuanceGeography?, credentials: [NuanceBotCredentials]?, variables: [NuanceBotVariable]?, transferNodes: [NuanceBotTransferNode]?, locales: [String]?, channels: [NuanceChannel]?, selfUri: String?) { + self._id = _id + self.name = name + self.integrationId = integrationId + self.nuanceOrganization = nuanceOrganization + self.application = application + self.nuanceEnvironment = nuanceEnvironment + self.geography = geography + self.credentials = credentials + self.variables = variables + self.transferNodes = transferNodes + self.locales = locales + self.channels = channels + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case integrationId + case nuanceOrganization + case application + case nuanceEnvironment + case geography + case credentials + case variables + case transferNodes + case locales + case channels + case selfUri + } + + +} + + + +/** Model for a Nuance bot environment */ + +public class NuanceEnvironment: Codable { + + + + + + + + + + /** The environment ID */ + public var _id: String? + /** The environment name */ + public var name: String? + /** The environment type, usually a value like SANDBOX or PRODUCTION */ + public var environmentDesignation: String? + /** The host used to execute this bot, similar to 'api.nuance.com:443' */ + public var executionHost: String? + + public init(_id: String?, name: String?, environmentDesignation: String?, executionHost: String?) { + self._id = _id + self.name = name + self.environmentDesignation = environmentDesignation + self.executionHost = executionHost + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + case environmentDesignation + case executionHost + } + + +} + + + + +public class OAuthClientEntityListing: Codable { + + + + + + + + + + + + + + + + + + + + + + public var entities: [OAuthClientListing]? + public var pageSize: Int? + public var pageNumber: Int? + public var total: Int64? + public var firstUri: String? + public var lastUri: String? + public var selfUri: String? + public var nextUri: String? + public var previousUri: String? + public var pageCount: Int? + + public init(entities: [OAuthClientListing]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { + self.entities = entities + self.pageSize = pageSize + self.pageNumber = pageNumber + self.total = total self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -25619,23 +25776,23 @@ public class OpenIntegrationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [OpenIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [OpenIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -26123,23 +26280,23 @@ public class OutboundDomainEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [OutboundDomain]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [OutboundDomain]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -26280,128 +26437,6 @@ public class OutboundMessagingMessagingCampaignConfigChangeContactSort: Codable -/** An outbound-messaging messaging campaign SMS Config */ - -public class OutboundMessagingMessagingCampaignConfigChangeSmsConfig: Codable { - - - - - - - - - - /** The Contact List column specifying the message to send to the contact. */ - public var messageColumn: String? - /** The Contact List column specifying the phone number to send a message to. */ - public var phoneColumn: String? - public var senderSmsPhoneNumber: OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef? - public var contentTemplate: OutboundMessagingMessagingCampaignConfigChangeResponseRef? - - public init(messageColumn: String?, phoneColumn: String?, senderSmsPhoneNumber: OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef?, contentTemplate: OutboundMessagingMessagingCampaignConfigChangeResponseRef?) { - self.messageColumn = messageColumn - self.phoneColumn = phoneColumn - self.senderSmsPhoneNumber = senderSmsPhoneNumber - self.contentTemplate = contentTemplate - } - - -} - - - -/** A reference for an SmsPhoneNumber */ - -public class OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef: Codable { - - - - /** The unique phone number */ - public var phoneNumber: String? - - public init(phoneNumber: String?) { - self.phoneNumber = phoneNumber - } - - -} - - - -/** A UriReference for a resource */ - -public class OutboundMessagingMessagingCampaignConfigChangeUriReference: Codable { - - - - - - /** The ID of the resource */ - public var _id: String? - /** The name of the resource */ - public var name: String? - - public init(_id: String?, name: String?) { - self._id = _id - self.name = name - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - } - - -} - - - - -public class OutboundMessagingMessagingCampaignProgressEventCampaignProgress: Codable { - - - - - - - - - - - - - - - - public var campaign: OutboundMessagingMessagingCampaignProgressEventUriReference? - /** The number of contacts that have been called so far */ - public var numberOfContactsCalled: Double? - /** The number of contacts that have been messaged so far */ - public var numberOfContactsMessaged: Double? - /** The total number of contacts in the contact list */ - public var totalNumberOfContacts: Double? - /** numberOfContactsContacted/totalNumberOfContacts*100 */ - public var percentage: Int? - /** A map of skipped reasons and the number of contacts associated with each. */ - public var numberOfContactsSkipped: [String:Int]? - public var additionalProperties: [String:JSON]? - - public init(campaign: OutboundMessagingMessagingCampaignProgressEventUriReference?, numberOfContactsCalled: Double?, numberOfContactsMessaged: Double?, totalNumberOfContacts: Double?, percentage: Int?, numberOfContactsSkipped: [String:Int]?, additionalProperties: [String:JSON]?) { - self.campaign = campaign - self.numberOfContactsCalled = numberOfContactsCalled - self.numberOfContactsMessaged = numberOfContactsMessaged - self.totalNumberOfContacts = totalNumberOfContacts - self.percentage = percentage - self.numberOfContactsSkipped = numberOfContactsSkipped - self.additionalProperties = additionalProperties - } - - -} - - - public class OutboundRoute: Codable { @@ -26536,6 +26571,128 @@ public class OutboundRoute: Codable { +/** An outbound-messaging messaging campaign SMS Config */ + +public class OutboundMessagingMessagingCampaignConfigChangeSmsConfig: Codable { + + + + + + + + + + /** The Contact List column specifying the message to send to the contact. */ + public var messageColumn: String? + /** The Contact List column specifying the phone number to send a message to. */ + public var phoneColumn: String? + public var senderSmsPhoneNumber: OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef? + public var contentTemplate: OutboundMessagingMessagingCampaignConfigChangeResponseRef? + + public init(messageColumn: String?, phoneColumn: String?, senderSmsPhoneNumber: OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef?, contentTemplate: OutboundMessagingMessagingCampaignConfigChangeResponseRef?) { + self.messageColumn = messageColumn + self.phoneColumn = phoneColumn + self.senderSmsPhoneNumber = senderSmsPhoneNumber + self.contentTemplate = contentTemplate + } + + +} + + + +/** A reference for an SmsPhoneNumber */ + +public class OutboundMessagingMessagingCampaignConfigChangeSmsPhoneNumberRef: Codable { + + + + /** The unique phone number */ + public var phoneNumber: String? + + public init(phoneNumber: String?) { + self.phoneNumber = phoneNumber + } + + +} + + + +/** A UriReference for a resource */ + +public class OutboundMessagingMessagingCampaignConfigChangeUriReference: Codable { + + + + + + /** The ID of the resource */ + public var _id: String? + /** The name of the resource */ + public var name: String? + + public init(_id: String?, name: String?) { + self._id = _id + self.name = name + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name + } + + +} + + + + +public class OutboundMessagingMessagingCampaignProgressEventCampaignProgress: Codable { + + + + + + + + + + + + + + + + public var campaign: OutboundMessagingMessagingCampaignProgressEventUriReference? + /** The number of contacts that have been called so far */ + public var numberOfContactsCalled: Double? + /** The number of contacts that have been messaged so far */ + public var numberOfContactsMessaged: Double? + /** The total number of contacts in the contact list */ + public var totalNumberOfContacts: Double? + /** numberOfContactsContacted/totalNumberOfContacts*100 */ + public var percentage: Int? + /** A map of skipped reasons and the number of contacts associated with each. */ + public var numberOfContactsSkipped: [String:Int]? + public var additionalProperties: [String:JSON]? + + public init(campaign: OutboundMessagingMessagingCampaignProgressEventUriReference?, numberOfContactsCalled: Double?, numberOfContactsMessaged: Double?, totalNumberOfContacts: Double?, percentage: Int?, numberOfContactsSkipped: [String:Int]?, additionalProperties: [String:JSON]?) { + self.campaign = campaign + self.numberOfContactsCalled = numberOfContactsCalled + self.numberOfContactsMessaged = numberOfContactsMessaged + self.totalNumberOfContacts = totalNumberOfContacts + self.percentage = percentage + self.numberOfContactsSkipped = numberOfContactsSkipped + self.additionalProperties = additionalProperties + } + + +} + + + public class OutcomeConfig: Codable { @@ -27075,6 +27232,44 @@ public class PerformancePredictionUploadSchema: Codable { +public class PermissionDetails: Codable { + + public enum ModelType: String, Codable { + case requirescurrentuser = "requiresCurrentUser" + case requirespermissions = "requiresPermissions" + case requiresdivisionpermissions = "requiresDivisionPermissions" + case requiresanydivisionpermissions = "requiresAnyDivisionPermissions" + case requiresuserbeconversationparticipant = "requiresUserBeConversationParticipant" + } + + + + + + + + /** The type of permission requirement */ + public var type: ModelType? + /** List of required permissions */ + public var permissions: [String]? + /** Whether the current user can subscribe, when division permissions are otherwise required */ + public var allowsCurrentUser: Bool? + /** Whether or not this permission requirement is enforced */ + public var enforced: Bool? + + public init(type: ModelType?, permissions: [String]?, allowsCurrentUser: Bool?, enforced: Bool?) { + self.type = type + self.permissions = permissions + self.allowsCurrentUser = allowsCurrentUser + self.enforced = enforced + } + + +} + + + + public class Permissions: Codable { @@ -27092,36 +27287,36 @@ public class Permissions: Codable { -public class PermissionDetails: Codable { +public class PersistentConnectionChangeTopicPersistentConnectionChangeEvent: Codable { - public enum ModelType: String, Codable { - case requirescurrentuser = "requiresCurrentUser" - case requirespermissions = "requiresPermissions" - case requiresdivisionpermissions = "requiresDivisionPermissions" - case requiresanydivisionpermissions = "requiresAnyDivisionPermissions" - case requiresuserbeconversationparticipant = "requiresUserBeConversationParticipant" - } + public enum PersistentState: String, Codable { + case unknown = "UNKNOWN" + case persisted = "PERSISTED" + case activeCall = "ACTIVE_CALL" + case disconnected = "DISCONNECTED" + case failed = "FAILED" + } - /** The type of permission requirement */ - public var type: ModelType? - /** List of required permissions */ - public var permissions: [String]? - /** Whether the current user can subscribe, when division permissions are otherwise required */ - public var allowsCurrentUser: Bool? - /** Whether or not this permission requirement is enforced */ - public var enforced: Bool? - public init(type: ModelType?, permissions: [String]?, allowsCurrentUser: Bool?, enforced: Bool?) { - self.type = type - self.permissions = permissions - self.allowsCurrentUser = allowsCurrentUser - self.enforced = enforced + + public var errorInfo: PersistentConnectionChangeTopicErrorInfo? + public var stationId: String? + public var userId: String? + public var persistentState: PersistentState? + public var eventTime: Date? + + public init(errorInfo: PersistentConnectionChangeTopicErrorInfo?, stationId: String?, userId: String?, persistentState: PersistentState?, eventTime: Date?) { + self.errorInfo = errorInfo + self.stationId = stationId + self.userId = userId + self.persistentState = persistentState + self.eventTime = eventTime } @@ -28263,15 +28458,15 @@ public class ProgramsEntityListing: Codable { public var entities: [ListedProgram]? public var pageSize: Int? - public var nextUri: String? public var selfUri: String? + public var nextUri: String? public var pageCount: Int? - public init(entities: [ListedProgram]?, pageSize: Int?, nextUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ListedProgram]?, pageSize: Int?, selfUri: String?, nextUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize - self.nextUri = nextUri self.selfUri = selfUri + self.nextUri = nextUri self.pageCount = pageCount } @@ -28766,16 +28961,11 @@ public class QuestionGroupSettings: Codable { - - - /** This field represents the location of the Question Group in the form. Note: Indexes are zero-based */ - public var questionGroupIndex: Int? /** The context id of the question group in the form. */ public var questionGroupContextId: String? public var questionSettings: [QuestionSettings]? - public init(questionGroupIndex: Int?, questionGroupContextId: String?, questionSettings: [QuestionSettings]?) { - self.questionGroupIndex = questionGroupIndex + public init(questionGroupContextId: String?, questionSettings: [QuestionSettings]?) { self.questionGroupContextId = questionGroupContextId self.questionSettings = questionSettings } @@ -28792,16 +28982,11 @@ public class QuestionSettings: Codable { - - - /** This field represents the location of the Question in the form. Note: Indexes are zero-based */ - public var questionIndex: Int? /** The context id of the question in the group */ public var questionContextId: String? public var settings: AiScoringSetting? - public init(questionIndex: Int?, questionContextId: String?, settings: AiScoringSetting?) { - self.questionIndex = questionIndex + public init(questionContextId: String?, settings: AiScoringSetting?) { self.questionContextId = questionContextId self.settings = settings } @@ -30814,244 +30999,6 @@ public class QueueConversationMessageEventTopicMessageMedia: Codable { -public class QueueConversationVideoEventTopicCall: Codable { - - - - public enum State: String, Codable { - case alerting = "alerting" - case dialing = "dialing" - case contacting = "contacting" - case offering = "offering" - case connected = "connected" - case disconnected = "disconnected" - case terminated = "terminated" - case uploading = "uploading" - case converting = "converting" - case transmitting = "transmitting" - case _none = "none" - } - - public enum InitialState: String, Codable { - case alerting = "alerting" - case dialing = "dialing" - case contacting = "contacting" - case offering = "offering" - case connected = "connected" - case disconnected = "disconnected" - case terminated = "terminated" - case uploading = "uploading" - case converting = "converting" - case transmitting = "transmitting" - case _none = "none" - } - - - - public enum RecordingState: String, Codable { - case _none = "none" - case active = "active" - case paused = "paused" - } - - - - - - - - - - - - public enum DisconnectType: String, Codable { - case endpoint = "endpoint" - case endpointDnd = "endpoint.dnd" - case client = "client" - case system = "system" - case timeout = "timeout" - case transfer = "transfer" - case transferConference = "transfer.conference" - case transferConsult = "transfer.consult" - case transferForward = "transfer.forward" - case transferNoanswer = "transfer.noanswer" - case transferNotavailable = "transfer.notavailable" - case transferDnd = "transfer.dnd" - case transportFailure = "transport.failure" - case error = "error" - case peer = "peer" - case other = "other" - case spam = "spam" - case uncallable = "uncallable" - } - - - - public enum Direction: String, Codable { - case outbound = "outbound" - case inbound = "inbound" - } - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /** A globally unique identifier for this communication. */ - public var _id: String? - public var state: State? - public var initialState: InitialState? - /** True if this call is being recorded. */ - public var recording: Bool? - /** State of recording on this call. */ - public var recordingState: RecordingState? - /** True if this call is muted so that remote participants can't hear any audio from this end. */ - public var muted: Bool? - /** True if this call is held and the person on this side hears hold music. */ - public var confined: Bool? - /** True if this call is held and the person on this side hears silence. */ - public var held: Bool? - /** True when the recording of this call is in secure pause status. */ - public var securePause: Bool? - public var errorInfo: QueueConversationVideoEventTopicErrorDetails? - /** System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. */ - public var disconnectType: DisconnectType? - /** The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. */ - public var startHoldTime: Date? - /** Whether a call is inbound or outbound. */ - public var direction: Direction? - /** If call is a fax of a document in content management, the id of the document in content management. */ - public var documentId: String? - public var _self: QueueConversationVideoEventTopicAddress? - /** Address and name data for a call endpoint. */ - public var other: QueueConversationVideoEventTopicAddress? - /** The source provider of the call. */ - public var provider: String? - /** The UUID of the script to use. */ - public var scriptId: String? - /** The id of the peer communication corresponding to a matching leg for this communication. */ - public var peerId: String? - /** The timestamp when this communication was connected in the cloud clock. */ - public var connectedTime: Date? - /** The timestamp when this communication disconnected from the conversation in the provider clock. */ - public var disconnectedTime: Date? - /** List of reasons that this call was disconnected. This will be set once the call disconnects. */ - public var disconnectReasons: [QueueConversationVideoEventTopicDisconnectReason]? - public var faxStatus: QueueConversationVideoEventTopicFaxStatus? - /** User to User Information (UUI) data managed by SIP session application. */ - public var uuiData: String? - /** The timestamp when this participant was connected to the barge conference in the provider clock. */ - public var bargedTime: Date? - /** Call wrap up or disposition data. */ - public var wrapup: QueueConversationVideoEventTopicWrapup? - public var afterCallWork: QueueConversationVideoEventTopicAfterCallWork? - /** Indicates if after-call is required for a communication. Only used when the ACW Setting is Agent Requested. */ - public var afterCallWorkRequired: Bool? - /** UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation. */ - public var agentAssistantId: String? - public var queueMediaSettings: QueueConversationVideoEventTopicQueueMediaSettings? - - public init(_id: String?, state: State?, initialState: InitialState?, recording: Bool?, recordingState: RecordingState?, muted: Bool?, confined: Bool?, held: Bool?, securePause: Bool?, errorInfo: QueueConversationVideoEventTopicErrorDetails?, disconnectType: DisconnectType?, startHoldTime: Date?, direction: Direction?, documentId: String?, _self: QueueConversationVideoEventTopicAddress?, other: QueueConversationVideoEventTopicAddress?, provider: String?, scriptId: String?, peerId: String?, connectedTime: Date?, disconnectedTime: Date?, disconnectReasons: [QueueConversationVideoEventTopicDisconnectReason]?, faxStatus: QueueConversationVideoEventTopicFaxStatus?, uuiData: String?, bargedTime: Date?, wrapup: QueueConversationVideoEventTopicWrapup?, afterCallWork: QueueConversationVideoEventTopicAfterCallWork?, afterCallWorkRequired: Bool?, agentAssistantId: String?, queueMediaSettings: QueueConversationVideoEventTopicQueueMediaSettings?) { - self._id = _id - self.state = state - self.initialState = initialState - self.recording = recording - self.recordingState = recordingState - self.muted = muted - self.confined = confined - self.held = held - self.securePause = securePause - self.errorInfo = errorInfo - self.disconnectType = disconnectType - self.startHoldTime = startHoldTime - self.direction = direction - self.documentId = documentId - self._self = _self - self.other = other - self.provider = provider - self.scriptId = scriptId - self.peerId = peerId - self.connectedTime = connectedTime - self.disconnectedTime = disconnectedTime - self.disconnectReasons = disconnectReasons - self.faxStatus = faxStatus - self.uuiData = uuiData - self.bargedTime = bargedTime - self.wrapup = wrapup - self.afterCallWork = afterCallWork - self.afterCallWorkRequired = afterCallWorkRequired - self.agentAssistantId = agentAssistantId - self.queueMediaSettings = queueMediaSettings - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case state - case initialState - case recording - case recordingState - case muted - case confined - case held - case securePause - case errorInfo - case disconnectType - case startHoldTime - case direction - case documentId - case _self = "self" - case other - case provider - case scriptId - case peerId - case connectedTime - case disconnectedTime - case disconnectReasons - case faxStatus - case uuiData - case bargedTime - case wrapup - case afterCallWork - case afterCallWorkRequired - case agentAssistantId - case queueMediaSettings - } - - -} - - - - public class QueueConversationMessageEventTopicMessageMetadataEvent: Codable { @@ -31320,6 +31267,26 @@ public class QueueConversationSocialExpressionEventTopicConversationDivisionMemb +public class QueueEmailAddress: Codable { + + + + + + public var domain: DomainEntityRef? + public var route: InboundRoute? + + public init(domain: DomainEntityRef?, route: InboundRoute?) { + self.domain = domain + self.route = route + } + + +} + + + + public class QueueConversationSocialExpressionEventTopicEmail: Codable { @@ -31929,6 +31896,244 @@ public class QueueConversationVideoEventTopicAddress: Codable { +public class QueueConversationVideoEventTopicCall: Codable { + + + + public enum State: String, Codable { + case alerting = "alerting" + case dialing = "dialing" + case contacting = "contacting" + case offering = "offering" + case connected = "connected" + case disconnected = "disconnected" + case terminated = "terminated" + case uploading = "uploading" + case converting = "converting" + case transmitting = "transmitting" + case _none = "none" + } + + public enum InitialState: String, Codable { + case alerting = "alerting" + case dialing = "dialing" + case contacting = "contacting" + case offering = "offering" + case connected = "connected" + case disconnected = "disconnected" + case terminated = "terminated" + case uploading = "uploading" + case converting = "converting" + case transmitting = "transmitting" + case _none = "none" + } + + + + public enum RecordingState: String, Codable { + case _none = "none" + case active = "active" + case paused = "paused" + } + + + + + + + + + + + + public enum DisconnectType: String, Codable { + case endpoint = "endpoint" + case endpointDnd = "endpoint.dnd" + case client = "client" + case system = "system" + case timeout = "timeout" + case transfer = "transfer" + case transferConference = "transfer.conference" + case transferConsult = "transfer.consult" + case transferForward = "transfer.forward" + case transferNoanswer = "transfer.noanswer" + case transferNotavailable = "transfer.notavailable" + case transferDnd = "transfer.dnd" + case transportFailure = "transport.failure" + case error = "error" + case peer = "peer" + case other = "other" + case spam = "spam" + case uncallable = "uncallable" + } + + + + public enum Direction: String, Codable { + case outbound = "outbound" + case inbound = "inbound" + } + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + /** A globally unique identifier for this communication. */ + public var _id: String? + public var state: State? + public var initialState: InitialState? + /** True if this call is being recorded. */ + public var recording: Bool? + /** State of recording on this call. */ + public var recordingState: RecordingState? + /** True if this call is muted so that remote participants can't hear any audio from this end. */ + public var muted: Bool? + /** True if this call is held and the person on this side hears hold music. */ + public var confined: Bool? + /** True if this call is held and the person on this side hears silence. */ + public var held: Bool? + /** True when the recording of this call is in secure pause status. */ + public var securePause: Bool? + public var errorInfo: QueueConversationVideoEventTopicErrorDetails? + /** System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. */ + public var disconnectType: DisconnectType? + /** The timestamp the call was placed on hold in the cloud clock if the call is currently on hold. */ + public var startHoldTime: Date? + /** Whether a call is inbound or outbound. */ + public var direction: Direction? + /** If call is a fax of a document in content management, the id of the document in content management. */ + public var documentId: String? + public var _self: QueueConversationVideoEventTopicAddress? + /** Address and name data for a call endpoint. */ + public var other: QueueConversationVideoEventTopicAddress? + /** The source provider of the call. */ + public var provider: String? + /** The UUID of the script to use. */ + public var scriptId: String? + /** The id of the peer communication corresponding to a matching leg for this communication. */ + public var peerId: String? + /** The timestamp when this communication was connected in the cloud clock. */ + public var connectedTime: Date? + /** The timestamp when this communication disconnected from the conversation in the provider clock. */ + public var disconnectedTime: Date? + /** List of reasons that this call was disconnected. This will be set once the call disconnects. */ + public var disconnectReasons: [QueueConversationVideoEventTopicDisconnectReason]? + public var faxStatus: QueueConversationVideoEventTopicFaxStatus? + /** User to User Information (UUI) data managed by SIP session application. */ + public var uuiData: String? + /** The timestamp when this participant was connected to the barge conference in the provider clock. */ + public var bargedTime: Date? + /** Call wrap up or disposition data. */ + public var wrapup: QueueConversationVideoEventTopicWrapup? + public var afterCallWork: QueueConversationVideoEventTopicAfterCallWork? + /** Indicates if after-call is required for a communication. Only used when the ACW Setting is Agent Requested. */ + public var afterCallWorkRequired: Bool? + /** UUID of virtual agent assistant that provide suggestions to the agent participant during the conversation. */ + public var agentAssistantId: String? + public var queueMediaSettings: QueueConversationVideoEventTopicQueueMediaSettings? + + public init(_id: String?, state: State?, initialState: InitialState?, recording: Bool?, recordingState: RecordingState?, muted: Bool?, confined: Bool?, held: Bool?, securePause: Bool?, errorInfo: QueueConversationVideoEventTopicErrorDetails?, disconnectType: DisconnectType?, startHoldTime: Date?, direction: Direction?, documentId: String?, _self: QueueConversationVideoEventTopicAddress?, other: QueueConversationVideoEventTopicAddress?, provider: String?, scriptId: String?, peerId: String?, connectedTime: Date?, disconnectedTime: Date?, disconnectReasons: [QueueConversationVideoEventTopicDisconnectReason]?, faxStatus: QueueConversationVideoEventTopicFaxStatus?, uuiData: String?, bargedTime: Date?, wrapup: QueueConversationVideoEventTopicWrapup?, afterCallWork: QueueConversationVideoEventTopicAfterCallWork?, afterCallWorkRequired: Bool?, agentAssistantId: String?, queueMediaSettings: QueueConversationVideoEventTopicQueueMediaSettings?) { + self._id = _id + self.state = state + self.initialState = initialState + self.recording = recording + self.recordingState = recordingState + self.muted = muted + self.confined = confined + self.held = held + self.securePause = securePause + self.errorInfo = errorInfo + self.disconnectType = disconnectType + self.startHoldTime = startHoldTime + self.direction = direction + self.documentId = documentId + self._self = _self + self.other = other + self.provider = provider + self.scriptId = scriptId + self.peerId = peerId + self.connectedTime = connectedTime + self.disconnectedTime = disconnectedTime + self.disconnectReasons = disconnectReasons + self.faxStatus = faxStatus + self.uuiData = uuiData + self.bargedTime = bargedTime + self.wrapup = wrapup + self.afterCallWork = afterCallWork + self.afterCallWorkRequired = afterCallWorkRequired + self.agentAssistantId = agentAssistantId + self.queueMediaSettings = queueMediaSettings + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case state + case initialState + case recording + case recordingState + case muted + case confined + case held + case securePause + case errorInfo + case disconnectType + case startHoldTime + case direction + case documentId + case _self = "self" + case other + case provider + case scriptId + case peerId + case connectedTime + case disconnectedTime + case disconnectReasons + case faxStatus + case uuiData + case bargedTime + case wrapup + case afterCallWork + case afterCallWorkRequired + case agentAssistantId + case queueMediaSettings + } + + +} + + + + public class QueueConversationVideoEventTopicConversation: Codable { @@ -32099,34 +32304,6 @@ public class QueueConversationVideoEventTopicPhoneNumberColumn: Codable { -/** A UriReference for a resource */ - -public class QueueConversationVideoEventTopicUriReference: Codable { - - - - - - /** The ID of the resource */ - public var _id: String? - /** The name of the resource */ - public var name: String? - - public init(_id: String?, name: String?) { - self._id = _id - self.name = name - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case name - } - - -} - - - public class QueueConversationVideoEventTopicSocialExpression: Codable { @@ -32319,19 +32496,27 @@ public class QueueConversationVideoEventTopicTransferModifedBy: Codable { +/** A UriReference for a resource */ -public class QueueEmailAddress: Codable { +public class QueueConversationVideoEventTopicUriReference: Codable { - public var domain: DomainEntityRef? - public var route: InboundRoute? + /** The ID of the resource */ + public var _id: String? + /** The name of the resource */ + public var name: String? - public init(domain: DomainEntityRef?, route: InboundRoute?) { - self.domain = domain - self.route = route + public init(_id: String?, name: String?) { + self._id = _id + self.name = name + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case name } @@ -32802,6 +32987,33 @@ public class RecordingEncryptionConfigurationListing: Codable { +public class Ring: Codable { + + + + + + + + /** The conditions that will trigger conversations to move to the next bullseye ring. */ + public var expansionCriteria: [ExpansionCriterium]? + /** The actions that will be performed just before moving conversations to the next bullseye ring. */ + public var actions: Actions? + /** The groups of agents associated with the ring, if any. Ring membership will update to match group membership changes. */ + public var memberGroups: [MemberGroup]? + + public init(expansionCriteria: [ExpansionCriterium]?, actions: Actions?, memberGroups: [MemberGroup]?) { + self.expansionCriteria = expansionCriteria + self.actions = actions + self.memberGroups = memberGroups + } + + +} + + + + public class RecordingJobEntityListing: Codable { @@ -32828,23 +33040,23 @@ public class RecordingJobEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [RecordingJob]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [RecordingJob]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -33264,23 +33476,23 @@ public class ReportingExportMetadataJobListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ReportingExportMetadataJobResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ReportingExportMetadataJobResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -33677,33 +33889,6 @@ public class RetentionDuration: Codable { -public class Ring: Codable { - - - - - - - - /** The conditions that will trigger conversations to move to the next bullseye ring. */ - public var expansionCriteria: [ExpansionCriterium]? - /** The actions that will be performed just before moving conversations to the next bullseye ring. */ - public var actions: Actions? - /** The groups of agents associated with the ring, if any. Ring membership will update to match group membership changes. */ - public var memberGroups: [MemberGroup]? - - public init(expansionCriteria: [ExpansionCriterium]?, actions: Actions?, memberGroups: [MemberGroup]?) { - self.expansionCriteria = expansionCriteria - self.actions = actions - self.memberGroups = memberGroups - } - - -} - - - - public class RoleDivisionPair: Codable { @@ -33990,23 +34175,23 @@ public class RuleSetEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [RuleSet]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [RuleSet]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -34045,17 +34230,22 @@ public class SalesforceSettings: Codable { + + /** Filter source by channel. */ public var channel: Channel? /** Filter source by language. */ public var language: String? /** Filter source by categories. */ public var categories: [String]? + /** The base URL to resources. */ + public var baseUrl: String? - public init(channel: Channel?, language: String?, categories: [String]?) { + public init(channel: Channel?, language: String?, categories: [String]?, baseUrl: String?) { self.channel = channel self.language = language self.categories = categories + self.baseUrl = baseUrl } @@ -34088,155 +34278,155 @@ public class ScheduleEntityListing: Codable { - public var entities: [Schedule]? - public var pageSize: Int? - public var pageNumber: Int? - public var total: Int64? - /** The total organization-wide number of entities. */ - public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? - public var firstUri: String? - public var selfUri: String? - public var pageCount: Int? - - public init(entities: [Schedule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { - self.entities = entities - self.pageSize = pageSize - self.pageNumber = pageNumber - self.total = total - self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri - self.firstUri = firstUri - self.selfUri = selfUri - self.pageCount = pageCount - } - - -} - - - - -public class ScheduleGenerationWarning: Codable { - - - - - - - - - public enum UnableToScheduleRequiredDays: String, Codable { - case sunday = "Sunday" - case monday = "Monday" - case tuesday = "Tuesday" - case wednesday = "Wednesday" - case thursday = "Thursday" - case friday = "Friday" - case saturday = "Saturday" - } - - - - - - public enum NoNeedDays: String, Codable { - case sunday = "Sunday" - case monday = "Monday" - case tuesday = "Tuesday" - case wednesday = "Wednesday" - case thursday = "Thursday" - case friday = "Friday" - case saturday = "Saturday" - } - - - /** ID of the user in the warning */ - public var userId: String? - /** Whether the user does not have the appropriate license to be scheduled */ - public var userNotLicensed: Bool? - /** Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan */ - public var unableToMeetMaxDays: Bool? - /** Days indicated as required to work in agent work plan where no viable shift was found to schedule */ - public var unableToScheduleRequiredDays: [UnableToScheduleRequiredDays]? - /** Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan */ - public var unableToMeetMinPaidForTheWeek: Bool? - /** Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan */ - public var unableToMeetMaxPaidForTheWeek: Bool? - /** Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels */ - public var noNeedDays: [NoNeedDays]? - /** Whether the schedule did not meet the minimum time between shifts defined in the agent work plan */ - public var shiftsTooCloseTogether: Bool? - - public init(userId: String?, userNotLicensed: Bool?, unableToMeetMaxDays: Bool?, unableToScheduleRequiredDays: [UnableToScheduleRequiredDays]?, unableToMeetMinPaidForTheWeek: Bool?, unableToMeetMaxPaidForTheWeek: Bool?, noNeedDays: [NoNeedDays]?, shiftsTooCloseTogether: Bool?) { - self.userId = userId - self.userNotLicensed = userNotLicensed - self.unableToMeetMaxDays = unableToMeetMaxDays - self.unableToScheduleRequiredDays = unableToScheduleRequiredDays - self.unableToMeetMinPaidForTheWeek = unableToMeetMinPaidForTheWeek - self.unableToMeetMaxPaidForTheWeek = unableToMeetMaxPaidForTheWeek - self.noNeedDays = noNeedDays - self.shiftsTooCloseTogether = shiftsTooCloseTogether - } - - -} - - - - -public class ScheduleGroupEntityListing: Codable { - - - - - - - - - - - - - - - - - - - - - - - - public var entities: [ScheduleGroup]? + public var entities: [Schedule]? public var pageSize: Int? public var pageNumber: Int? public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ScheduleGroup]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Schedule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities + self.firstUri = firstUri + self.lastUri = lastUri + self.selfUri = selfUri self.nextUri = nextUri self.previousUri = previousUri - self.lastUri = lastUri + self.pageCount = pageCount + } + + +} + + + + +public class ScheduleGenerationWarning: Codable { + + + + + + + + + public enum UnableToScheduleRequiredDays: String, Codable { + case sunday = "Sunday" + case monday = "Monday" + case tuesday = "Tuesday" + case wednesday = "Wednesday" + case thursday = "Thursday" + case friday = "Friday" + case saturday = "Saturday" + } + + + + + + public enum NoNeedDays: String, Codable { + case sunday = "Sunday" + case monday = "Monday" + case tuesday = "Tuesday" + case wednesday = "Wednesday" + case thursday = "Thursday" + case friday = "Friday" + case saturday = "Saturday" + } + + + /** ID of the user in the warning */ + public var userId: String? + /** Whether the user does not have the appropriate license to be scheduled */ + public var userNotLicensed: Bool? + /** Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan */ + public var unableToMeetMaxDays: Bool? + /** Days indicated as required to work in agent work plan where no viable shift was found to schedule */ + public var unableToScheduleRequiredDays: [UnableToScheduleRequiredDays]? + /** Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan */ + public var unableToMeetMinPaidForTheWeek: Bool? + /** Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan */ + public var unableToMeetMaxPaidForTheWeek: Bool? + /** Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels */ + public var noNeedDays: [NoNeedDays]? + /** Whether the schedule did not meet the minimum time between shifts defined in the agent work plan */ + public var shiftsTooCloseTogether: Bool? + + public init(userId: String?, userNotLicensed: Bool?, unableToMeetMaxDays: Bool?, unableToScheduleRequiredDays: [UnableToScheduleRequiredDays]?, unableToMeetMinPaidForTheWeek: Bool?, unableToMeetMaxPaidForTheWeek: Bool?, noNeedDays: [NoNeedDays]?, shiftsTooCloseTogether: Bool?) { + self.userId = userId + self.userNotLicensed = userNotLicensed + self.unableToMeetMaxDays = unableToMeetMaxDays + self.unableToScheduleRequiredDays = unableToScheduleRequiredDays + self.unableToMeetMinPaidForTheWeek = unableToMeetMinPaidForTheWeek + self.unableToMeetMaxPaidForTheWeek = unableToMeetMaxPaidForTheWeek + self.noNeedDays = noNeedDays + self.shiftsTooCloseTogether = shiftsTooCloseTogether + } + + +} + + + + +public class ScheduleGroupEntityListing: Codable { + + + + + + + + + + + + + + + + + + + + + + + + public var entities: [ScheduleGroup]? + public var pageSize: Int? + public var pageNumber: Int? + public var total: Int64? + /** The total organization-wide number of entities. */ + public var totalNumberOfEntities: Int64? + public var firstUri: String? + public var lastUri: String? + public var selfUri: String? + public var nextUri: String? + public var previousUri: String? + public var pageCount: Int? + + public init(entities: [ScheduleGroup]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { + self.entities = entities + self.pageSize = pageSize + self.pageNumber = pageNumber + self.total = total + self.totalNumberOfEntities = totalNumberOfEntities self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -36770,24 +36960,24 @@ public class StationEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Station]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Station]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -36861,23 +37051,23 @@ public class SttEngineEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SttEngineEntity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SttEngineEntity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -37281,23 +37471,23 @@ public class SurveyFormEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SurveyForm]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SurveyForm]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -37446,23 +37636,23 @@ public class TagValueEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [TagValue]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [TagValue]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -38453,23 +38643,23 @@ public class TtsEngineEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [TtsEngineEntity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [TtsEngineEntity]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -38691,23 +38881,23 @@ public class UnifiedCommunicationsIntegrationListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UnifiedCommunicationsIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UnifiedCommunicationsIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -38731,16 +38921,16 @@ public class UnpublishedProgramsEntityListing: Codable { public var entities: [Program]? public var pageSize: Int? - public var nextUri: String? public var selfUri: String? public var pageCount: Int? + public var nextUri: String? - public init(entities: [Program]?, pageSize: Int?, nextUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Program]?, pageSize: Int?, selfUri: String?, pageCount: Int?, nextUri: String?) { self.entities = entities self.pageSize = pageSize - self.nextUri = nextUri self.selfUri = selfUri self.pageCount = pageCount + self.nextUri = nextUri } @@ -42332,23 +42522,23 @@ public class WebChatMemberInfoEntityList: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [WebChatMemberInfo]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [WebChatMemberInfo]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -45272,23 +45462,23 @@ public class WorkspaceEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Workspace]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Workspace]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -45324,23 +45514,23 @@ public class WorkspaceMemberEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [WorkspaceMember]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [WorkspaceMember]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -45685,23 +45875,23 @@ public class WrapupCodeEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [WrapupCode]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [WrapupCode]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } diff --git a/build/src/Models/PlatformAPIModelsP5.swift b/build/src/Models/PlatformAPIModelsP5.swift index 54f26a5c7..068efc7ef 100644 --- a/build/src/Models/PlatformAPIModelsP5.swift +++ b/build/src/Models/PlatformAPIModelsP5.swift @@ -486,23 +486,23 @@ public class ActionTargetListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ActionTarget]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ActionTarget]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -3245,23 +3245,23 @@ public class AssignedLearningModuleDomainEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [AssignedLearningModule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [AssignedLearningModule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -3843,6 +3843,7 @@ public class AuditTopicAuditLogMessage: Codable { case nerService = "NerService" case onboarding = "Onboarding" case socialListening = "SocialListening" + case businessRules = "BusinessRules" } @@ -4129,6 +4130,7 @@ public class AuditTopicAuditLogMessage: Codable { case dashboardSettings = "DashboardSettings" case insightSettings = "InsightSettings" case analyticsReportingSettings = "AnalyticsReportingSettings" + case customCalculations = "CustomCalculations" case scheduledExports = "ScheduledExports" case exports = "Exports" case changeRequest = "ChangeRequest" @@ -4190,6 +4192,10 @@ public class AuditTopicAuditLogMessage: Codable { case journeyView = "JourneyView" case customEntity = "CustomEntity" case directoryFeature = "DirectoryFeature" + case ruleCategory = "RuleCategory" + case decisionTable = "DecisionTable" + case decisionTableVersion = "DecisionTableVersion" + case decisionTableRow = "DecisionTableRow" } @@ -6142,23 +6148,23 @@ public class CallHistoryConversationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CallHistoryConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CallHistoryConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -7204,23 +7210,23 @@ public class ChatConversationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ChatConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ChatConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -7869,23 +7875,23 @@ public class CommonRuleContainer: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [CommonRule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [CommonRule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -8211,6 +8217,135 @@ public class ContactBulkSearchParameters: Codable { +public class ContactImportJobEntityListing: Codable { + + + + + + + + + + + + public var entities: [ContactImportJobResponse]? + public var nextUri: String? + public var selfUri: String? + public var previousUri: String? + /** The cursor that points to the next set of entities being returned. */ + public var cursors: Cursors? + + public init(entities: [ContactImportJobResponse]?, nextUri: String?, selfUri: String?, previousUri: String?, cursors: Cursors?) { + self.entities = entities + self.nextUri = nextUri + self.selfUri = selfUri + self.previousUri = previousUri + self.cursors = cursors + } + + +} + + + + +public class ContactImportJobResponse: Codable { + + + + public enum Status: String, Codable { + case created = "Created" + case running = "Running" + case completed = "Completed" + case failed = "Failed" + case cancelled = "Cancelled" + } + + + + public enum ExecutionStep: String, Codable { + case validating = "Validating" + case validated = "Validated" + case importing = "Importing" + } + + + + + + + + + + /** The globally unique identifier for the object. */ + public var _id: String? + public var status: Status? + /** Detailed description for JobStatus. */ + public var statusDetails: String? + /** Detailed description for the Job execution state */ + public var executionStep: ExecutionStep? + /** Metadata for the job */ + public var metadata: ContactImportJobMetadata? + /** Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateCreated: Date? + /** The URI for this object */ + public var selfUri: String? + /** Settings */ + public var settings: AddressableEntityRef? + + public init(_id: String?, status: Status?, statusDetails: String?, executionStep: ExecutionStep?, metadata: ContactImportJobMetadata?, dateCreated: Date?, selfUri: String?, settings: AddressableEntityRef?) { + self._id = _id + self.status = status + self.statusDetails = statusDetails + self.executionStep = executionStep + self.metadata = metadata + self.dateCreated = dateCreated + self.selfUri = selfUri + self.settings = settings + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case status + case statusDetails + case executionStep + case metadata + case dateCreated + case selfUri + case settings + } + + +} + + + + +public class ContactImportJobStatusUpdateResponse: Codable { + + + + public enum Status: String, Codable { + case _continue = "Continue" + case cancel = "Cancel" + case retry = "Retry" + } + + public var jobId: String? + public var status: Status? + + public init(jobId: String?, status: Status?) { + self.jobId = jobId + self.status = status + } + + +} + + + + public class ContactListDivisionView: Codable { @@ -8305,23 +8440,23 @@ public class ContactListDivisionViewListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ContactListDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ContactListDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -8487,24 +8622,24 @@ public class ContactListing: Codable { public var pageNumber: Int? public var total: Int64? public var partialResults: Bool? - public var nextUri: String? public var firstUri: String? public var selfUri: String? - public var previousUri: String? + public var nextUri: String? public var lastUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ExternalContact]?, pageSize: Int?, pageNumber: Int?, total: Int64?, partialResults: Bool?, nextUri: String?, firstUri: String?, selfUri: String?, previousUri: String?, lastUri: String?, pageCount: Int?) { + public init(entities: [ExternalContact]?, pageSize: Int?, pageNumber: Int?, total: Int64?, partialResults: Bool?, firstUri: String?, selfUri: String?, nextUri: String?, lastUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.partialResults = partialResults - self.nextUri = nextUri self.firstUri = firstUri self.selfUri = selfUri - self.previousUri = previousUri + self.nextUri = nextUri self.lastUri = lastUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -10970,6 +11105,7 @@ public class ConversationMessageMetadataContent: Codable { case carousel = "Carousel" case text = "Text" case quickReplyV2 = "QuickReplyV2" + case datePicker = "DatePicker" case unknown = "Unknown" } @@ -11647,32 +11783,6 @@ public class ConversationVideoEventTopicConversationDivisionMembership: Codable - -public class CopilotAction: Codable { - - public enum ActionType: String, Codable { - case knowledgeArticle = "KnowledgeArticle" - case cannedResponse = "CannedResponse" - case script = "Script" - } - - - - /** Type of action. */ - public var actionType: ActionType? - /** Action specific attributes, if any. Maximum 100 of string key-value pair allowed. */ - public var attributes: [String:String]? - - public init(actionType: ActionType?, attributes: [String:String]?) { - self.actionType = actionType - self.attributes = attributes - } - - -} - - - /** A subset of the Journey System's customer data at a point-in-time (for external linkage and internal usage/context) */ public class ConversationVideoEventTopicJourneyCustomer: Codable { @@ -11801,6 +11911,32 @@ public class ConversationVideoEventTopicVideoConversation: Codable { + +public class CopilotAction: Codable { + + public enum ActionType: String, Codable { + case knowledgeArticle = "KnowledgeArticle" + case cannedResponse = "CannedResponse" + case script = "Script" + } + + + + /** Type of action. */ + public var actionType: ActionType? + /** Action specific attributes, if any. Maximum 100 of string key-value pair allowed. */ + public var attributes: [String:String]? + + public init(actionType: ActionType?, attributes: [String:String]?) { + self.actionType = actionType + self.attributes = attributes + } + + +} + + + /** Used to copy a VoicemailMessage to either a User or a Group */ public class CopyVoicemailMessage: Codable { @@ -12719,24 +12855,24 @@ public class DIDEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DID]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DID]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -12844,24 +12980,24 @@ public class DIDPoolEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DIDPool]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DIDPool]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -14096,23 +14232,23 @@ public class DirectoryUserDevicesListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UserDevice]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UserDevice]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -14148,23 +14284,23 @@ public class DncListEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [DncList]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [DncList]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -14475,33 +14611,6 @@ public class DocumentBodyList: Codable { -public class DocumentFaq: Codable { - - - - - - - - /** The question for this FAQ */ - public var question: String? - /** The answer for this FAQ */ - public var answer: String? - /** List of Alternative questions related to the answer which helps in improving the likelihood of a match to user query */ - public var alternatives: [String]? - - public init(question: String?, answer: String?, alternatives: [String]?) { - self.question = question - self.answer = answer - self.alternatives = alternatives - } - - -} - - - - public class DocumentBodyListBlockProperties: Codable { public enum UnorderedType: String, Codable { @@ -14884,6 +14993,33 @@ public class DocumentContentHighlightIndex: Codable { +public class DocumentFaq: Codable { + + + + + + + + /** The question for this FAQ */ + public var question: String? + /** The answer for this FAQ */ + public var answer: String? + /** List of Alternative questions related to the answer which helps in improving the likelihood of a match to user query */ + public var alternatives: [String]? + + public init(question: String?, answer: String?, alternatives: [String]?) { + self.question = question + self.answer = answer + self.alternatives = alternatives + } + + +} + + + + public class DocumentListing: Codable { @@ -16320,23 +16456,23 @@ public class EncryptionKeyEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EncryptionKey]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EncryptionKey]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -16451,23 +16587,23 @@ public class EvaluationFormResponseEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [EvaluationFormResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [EvaluationFormResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -18489,23 +18625,23 @@ public class FlowSettingsResponseEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [FlowSettingsResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [FlowSettingsResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19097,23 +19233,23 @@ public class GetCelebrationListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Celebration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Celebration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19270,23 +19406,23 @@ public class GrammarListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Grammar]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Grammar]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -19412,23 +19548,23 @@ public class GreetingListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Greeting]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Greeting]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -20540,24 +20676,24 @@ public class IVRDivisionViewEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [IVRDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [IVRDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -20708,23 +20844,23 @@ public class InboundDomainEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [InboundDomain]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [InboundDomain]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -21520,23 +21656,23 @@ public class IntegrationTypeEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [IntegrationType]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [IntegrationType]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -23416,102 +23552,6 @@ public class KnowledgeDocumentVersionListing: Codable { -public class Limit: Codable { - - - - public enum Namespace: String, Codable { - case agentAssistant = "agent.assistant" - case analyticsAlerting = "analytics.alerting" - case analytics = "analytics" - case analyticsRealtime = "analytics.realtime" - case analyticsReportingSettings = "analytics.reporting.settings" - case architect = "architect" - case audiohook = "audiohook" - case audit = "audit" - case authApi = "auth.api" - case authorization = "authorization" - case automationTesting = "automation.testing" - case bots = "bots" - case botsVoice = "bots.voice" - case businessRules = "business.rules" - case callback = "callback" - case cobrowse = "cobrowse" - case contentManagement = "content.management" - case conversation = "conversation" - case dataactions = "dataactions" - case datatables = "datatables" - case directory = "directory" - case email = "email" - case employeeEngagement = "employee.engagement" - case eventOrchestration = "event.orchestration" - case externalContacts = "external.contacts" - case gamification = "gamification" - case gcv = "gcv" - case gdpr = "gdpr" - case groups = "groups" - case historicalAdherence = "historical.adherence" - case infrastructureascode = "infrastructureascode" - case integrations = "integrations" - case intentMiner = "intent.miner" - case internalMessaging = "internal.messaging" - case journey = "journey" - case knowledge = "knowledge" - case languageUnderstanding = "language.understanding" - case learning = "learning" - case limitRegistry = "limit.registry" - case marketplace = "marketplace" - case mediaCommunications = "media.communications" - case messaging = "messaging" - case notifications = "notifications" - case onboarding = "onboarding" - case outbound = "outbound" - case platformApi = "platform.api" - case predictiveRouting = "predictive.routing" - case presence = "presence" - case quality = "quality" - case recording = "recording" - case responseManagement = "response.management" - case routing = "routing" - case scim = "scim" - case search = "search" - case secondaryAutomationTesting = "secondary.automation.testing" - case skills = "skills" - case socialMedia = "social.media" - case speechAndTextAnalytics = "speech.and.text.analytics" - case speechIntegration = "speech.integration" - case supportability = "supportability" - case taskManagement = "task.management" - case telephonyConfiguration = "telephony.configuration" - case usage = "usage" - case users = "users" - case webDeployments = "web.deployments" - case webMessaging = "web.messaging" - case webchat = "webchat" - case webhooks = "webhooks" - case workforceManagementForecast = "workforce.management.forecast" - case workforceManagement = "workforce.management" - case system = "system" - } - - - - public var key: String? - public var namespace: Namespace? - public var value: Int64? - - public init(key: String?, namespace: Namespace?, value: Int64?) { - self.key = key - self.namespace = namespace - self.value = value - } - - -} - - - - public class KnowledgeGuestDocumentResponse: Codable { @@ -24201,23 +24241,23 @@ public class LanguageEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Language]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Language]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -25170,6 +25210,102 @@ public class LicenseAssignmentRequest: Codable { +public class Limit: Codable { + + + + public enum Namespace: String, Codable { + case agentAssistant = "agent.assistant" + case analyticsAlerting = "analytics.alerting" + case analytics = "analytics" + case analyticsRealtime = "analytics.realtime" + case analyticsReportingSettings = "analytics.reporting.settings" + case architect = "architect" + case audiohook = "audiohook" + case audit = "audit" + case authApi = "auth.api" + case authorization = "authorization" + case automationTesting = "automation.testing" + case bots = "bots" + case botsVoice = "bots.voice" + case businessRules = "business.rules" + case callback = "callback" + case cobrowse = "cobrowse" + case contentManagement = "content.management" + case conversation = "conversation" + case dataactions = "dataactions" + case datatables = "datatables" + case directory = "directory" + case email = "email" + case employeeEngagement = "employee.engagement" + case eventOrchestration = "event.orchestration" + case externalContacts = "external.contacts" + case gamification = "gamification" + case gcv = "gcv" + case gdpr = "gdpr" + case groups = "groups" + case historicalAdherence = "historical.adherence" + case infrastructureascode = "infrastructureascode" + case integrations = "integrations" + case intentMiner = "intent.miner" + case internalMessaging = "internal.messaging" + case journey = "journey" + case knowledge = "knowledge" + case languageUnderstanding = "language.understanding" + case learning = "learning" + case limitRegistry = "limit.registry" + case marketplace = "marketplace" + case mediaCommunications = "media.communications" + case messaging = "messaging" + case notifications = "notifications" + case onboarding = "onboarding" + case outbound = "outbound" + case platformApi = "platform.api" + case predictiveRouting = "predictive.routing" + case presence = "presence" + case quality = "quality" + case recording = "recording" + case responseManagement = "response.management" + case routing = "routing" + case scim = "scim" + case search = "search" + case secondaryAutomationTesting = "secondary.automation.testing" + case skills = "skills" + case socialMedia = "social.media" + case speechAndTextAnalytics = "speech.and.text.analytics" + case speechIntegration = "speech.integration" + case supportability = "supportability" + case taskManagement = "task.management" + case telephonyConfiguration = "telephony.configuration" + case usage = "usage" + case users = "users" + case webDeployments = "web.deployments" + case webMessaging = "web.messaging" + case webchat = "webchat" + case webhooks = "webhooks" + case workforceManagementForecast = "workforce.management.forecast" + case workforceManagement = "workforce.management" + case system = "system" + } + + + + public var key: String? + public var namespace: Namespace? + public var value: Int64? + + public init(key: String?, namespace: Namespace?, value: Int64?) { + self.key = key + self.namespace = namespace + self.value = value + } + + +} + + + + public class LimitDocumentation: Codable { @@ -25790,23 +25926,23 @@ public class MessageConversationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [MessageConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [MessageConversation]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -25984,23 +26120,23 @@ public class MessagingCampaignDivisionViewEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [MessagingCampaignDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [MessagingCampaignDivisionView]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -26036,23 +26172,23 @@ public class MessagingCampaignScheduleEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [MessagingCampaignSchedule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [MessagingCampaignSchedule]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -26807,23 +26943,23 @@ public class NluFeedbackListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [NluFeedbackResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [NluFeedbackResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -26987,24 +27123,24 @@ public class NoteListing: Codable { public var pageNumber: Int? public var total: Int64? public var partialResults: Bool? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Note]?, pageSize: Int?, pageNumber: Int?, total: Int64?, partialResults: Bool?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Note]?, pageSize: Int?, pageNumber: Int?, total: Int64?, partialResults: Bool?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.partialResults = partialResults - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -27902,23 +28038,23 @@ public class OrphanRecordingListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [OrphanRecording]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [OrphanRecording]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -28236,24 +28372,24 @@ public class OutboundRouteBaseEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [OutboundRouteBase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [OutboundRouteBase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -28969,130 +29105,6 @@ public class PatchUser: Codable { -public class PerformancePredictionOutputs: Codable { - - - - - - - - /** Date as an ISO-8601 string, corresponding to the beginning of the performance prediction results */ - public var calculationStartDate: Date? - /** Interval length of the response metrics */ - public var calculationIntervalLengthMinutes: Int? - /** List of planning group level performance prediction results */ - public var planningGroupResults: [PlanningGroupOutputs]? - - public init(calculationStartDate: Date?, calculationIntervalLengthMinutes: Int?, planningGroupResults: [PlanningGroupOutputs]?) { - self.calculationStartDate = calculationStartDate - self.calculationIntervalLengthMinutes = calculationIntervalLengthMinutes - self.planningGroupResults = planningGroupResults - } - - -} - - - - -public class PerformancePredictionRecalculationResponse: Codable { - - - - - - - - public enum State: String, Codable { - case processing = "Processing" - case complete = "Complete" - case error = "Error" - } - - /** The operationId for which to listen */ - public var operationId: String? - /** The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete' */ - public var downloadUrl: String? - /** Result will always come via downloadUrls; however the schema is included for documentation */ - public var downloadResult: PerformancePredictionOutputs? - /** The state of the performance prediction */ - public var state: State? - - public init(operationId: String?, downloadUrl: String?, downloadResult: PerformancePredictionOutputs?, state: State?) { - self.operationId = operationId - self.downloadUrl = downloadUrl - self.downloadResult = downloadResult - self.state = state - } - - -} - - - - -public class PerformancePredictionResponse: Codable { - - - - - - - - - - - - public enum State: String, Codable { - case processing = "Processing" - case complete = "Complete" - case error = "Error" - } - - - - /** The globally unique identifier for the object. */ - public var _id: String? - /** 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 */ - public var weekDate: Date? - /** The ID of the schedule this performance prediction is associated with */ - public var scheduleId: String? - /** The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete' */ - public var downloadUrl: String? - /** Result will always come via downloadUrls; however the schema is included for documentation */ - public var downloadResult: PerformancePredictionOutputs? - /** The state of the performance prediction */ - public var state: State? - /** The URI for this object */ - public var selfUri: String? - - public init(_id: String?, weekDate: Date?, scheduleId: String?, downloadUrl: String?, downloadResult: PerformancePredictionOutputs?, state: State?, selfUri: String?) { - self._id = _id - self.weekDate = weekDate - self.scheduleId = scheduleId - self.downloadUrl = downloadUrl - self.downloadResult = downloadResult - self.state = state - self.selfUri = selfUri - } - - public enum CodingKeys: String, CodingKey { - case _id = "id" - case weekDate - case scheduleId - case downloadUrl - case downloadResult - case state - case selfUri - } - - -} - - - - public class Phone: Codable { @@ -29262,105 +29274,25 @@ public class Phone: Codable { -public class Phrase: Codable { - - - - public enum Strictness: String, Codable { - case _1 = "1" - case _55 = "55" - case _65 = "65" - case _72 = "72" - case _85 = "85" - case _90 = "90" - } - - public enum Sentiment: String, Codable { - case unspecified = "Unspecified" - case positive = "Positive" - case neutral = "Neutral" - case negative = "Negative" - } - - /** The phrase text */ - public var text: String? - /** The phrase strictness, default value is null */ - public var strictness: Strictness? - /** The phrase sentiment, default value is Unspecified. Note: Sentiment value for phrases is currently not in use and has no impact to the system. */ - public var sentiment: Sentiment? - - public init(text: String?, strictness: Strictness?, sentiment: Sentiment?) { - self.text = text - self.strictness = strictness - self.sentiment = sentiment - } - - -} - - - - -public class PolicyEntityListing: Codable { - - - - - - - - - - - - - - - - - - - - - - public var entities: [Policy]? - public var pageSize: Int? - public var pageNumber: Int? - public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? - public var firstUri: String? - public var selfUri: String? - public var pageCount: Int? - - public init(entities: [Policy]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { - self.entities = entities - self.pageSize = pageSize - self.pageNumber = pageNumber - self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri - self.firstUri = firstUri - self.selfUri = selfUri - self.pageCount = pageCount - } - +public class PerformancePredictionOutputs: Codable { -} -public class PolicyErrors: Codable { + /** Date as an ISO-8601 string, corresponding to the beginning of the performance prediction results */ + public var calculationStartDate: Date? + /** Interval length of the response metrics */ + public var calculationIntervalLengthMinutes: Int? + /** List of planning group level performance prediction results */ + public var planningGroupResults: [PlanningGroupOutputs]? - public var policyErrorMessages: [PolicyErrorMessage]? - - public init(policyErrorMessages: [PolicyErrorMessage]?) { - self.policyErrorMessages = policyErrorMessages + public init(calculationStartDate: Date?, calculationIntervalLengthMinutes: Int?, planningGroupResults: [PlanningGroupOutputs]?) { + self.calculationStartDate = calculationStartDate + self.calculationIntervalLengthMinutes = calculationIntervalLengthMinutes + self.planningGroupResults = planningGroupResults } @@ -29368,14 +29300,8 @@ public class PolicyErrors: Codable { -/** Definition of an Action to be created or updated. */ - -public class PostActionInput: Codable { - - - - +public class PerformancePredictionRecalculationResponse: Codable { @@ -29383,27 +29309,26 @@ public class PostActionInput: Codable { + public enum State: String, Codable { + case processing = "Processing" + case complete = "Complete" + case error = "Error" + } - /** Category of action, Can be up to 256 characters long */ - public var category: String? - /** Name of action, Can be up to 256 characters long */ - public var name: String? - /** The ID of the integration this action is associated to */ - public var integrationId: String? - /** Configuration to support request and response processing */ - public var config: ActionConfig? - /** Action contract */ - public var contract: ActionContractInput? - /** Indication of whether or not the action is designed to accept sensitive data */ - public var secure: Bool? + /** The operationId for which to listen */ + public var operationId: String? + /** The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete' */ + public var downloadUrl: String? + /** Result will always come via downloadUrls; however the schema is included for documentation */ + public var downloadResult: PerformancePredictionOutputs? + /** The state of the performance prediction */ + public var state: State? - public init(category: String?, name: String?, integrationId: String?, config: ActionConfig?, contract: ActionContractInput?, secure: Bool?) { - self.category = category - self.name = name - self.integrationId = integrationId - self.config = config - self.contract = contract - self.secure = secure + public init(operationId: String?, downloadUrl: String?, downloadResult: PerformancePredictionOutputs?, state: State?) { + self.operationId = operationId + self.downloadUrl = downloadUrl + self.downloadResult = downloadResult + self.state = state } @@ -29412,87 +29337,58 @@ public class PostActionInput: Codable { -public class PresenceEventUserPresence: Codable { - - - - - - - - - - +public class PerformancePredictionResponse: Codable { - public var source: String? - public var presenceDefinition: PresenceEventOrganizationPresence? - public var primary: Bool? - public var message: String? - public var modifiedDate: Date? - public init(source: String?, presenceDefinition: PresenceEventOrganizationPresence?, primary: Bool?, message: String?, modifiedDate: Date?) { - self.source = source - self.presenceDefinition = presenceDefinition - self.primary = primary - self.message = message - self.modifiedDate = modifiedDate - } -} -public class ProgramJob: Codable { public enum State: String, Codable { - case running = "Running" - case completed = "Completed" - case failed = "Failed" + case processing = "Processing" + case complete = "Complete" + case error = "Error" } - - - - - - - - /** The globally unique identifier for the object. */ public var _id: String? + /** 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 */ + public var weekDate: Date? + /** The ID of the schedule this performance prediction is associated with */ + public var scheduleId: String? + /** The url to GET the results of the performance prediction. This field is populated only if query state is 'Complete' */ + public var downloadUrl: String? + /** Result will always come via downloadUrls; however the schema is included for documentation */ + public var downloadResult: PerformancePredictionOutputs? + /** The state of the performance prediction */ public var state: State? - public var programs: [BaseProgramEntity]? - public var createdBy: AddressableEntityRef? - /** Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ - public var dateCreated: Date? - /** Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ - public var dateModified: Date? /** The URI for this object */ public var selfUri: String? - public init(_id: String?, state: State?, programs: [BaseProgramEntity]?, createdBy: AddressableEntityRef?, dateCreated: Date?, dateModified: Date?, selfUri: String?) { + public init(_id: String?, weekDate: Date?, scheduleId: String?, downloadUrl: String?, downloadResult: PerformancePredictionOutputs?, state: State?, selfUri: String?) { self._id = _id + self.weekDate = weekDate + self.scheduleId = scheduleId + self.downloadUrl = downloadUrl + self.downloadResult = downloadResult self.state = state - self.programs = programs - self.createdBy = createdBy - self.dateCreated = dateCreated - self.dateModified = dateModified self.selfUri = selfUri } public enum CodingKeys: String, CodingKey { case _id = "id" + case weekDate + case scheduleId + case downloadUrl + case downloadResult case state - case programs - case createdBy - case dateCreated - case dateModified case selfUri } @@ -29502,47 +29398,37 @@ public class ProgramJob: Codable { -public class ProgramJobRequest: Codable { +public class Phrase: Codable { - /** The ids of the programs used for this job */ - public var programIds: [String]? - - public init(programIds: [String]?) { - self.programIds = programIds + public enum Strictness: String, Codable { + case _1 = "1" + case _55 = "55" + case _65 = "65" + case _72 = "72" + case _85 = "85" + case _90 = "90" } + public enum Sentiment: String, Codable { + case unspecified = "Unspecified" + case positive = "Positive" + case neutral = "Neutral" + case negative = "Negative" + } -} - - - - -public class ProgramsMappingsEntityListing: Codable { - - - - - - - - - - - - public var entities: [ProgramMappings]? - public var pageSize: Int? - public var nextUri: String? - public var selfUri: String? - public var pageCount: Int? + /** The phrase text */ + public var text: String? + /** The phrase strictness, default value is null */ + public var strictness: Strictness? + /** The phrase sentiment, default value is Unspecified. Note: Sentiment value for phrases is currently not in use and has no impact to the system. */ + public var sentiment: Sentiment? - public init(entities: [ProgramMappings]?, pageSize: Int?, nextUri: String?, selfUri: String?, pageCount: Int?) { - self.entities = entities - self.pageSize = pageSize - self.nextUri = nextUri - self.selfUri = selfUri - self.pageCount = pageCount + public init(text: String?, strictness: Strictness?, sentiment: Sentiment?) { + self.text = text + self.strictness = strictness + self.sentiment = sentiment } @@ -29551,7 +29437,7 @@ public class ProgramsMappingsEntityListing: Codable { -public class PromptAssetEntityListing: Codable { +public class PolicyEntityListing: Codable { @@ -29573,27 +29459,277 @@ public class PromptAssetEntityListing: Codable { - public var entities: [PromptAsset]? + public var entities: [Policy]? public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [PromptAsset]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Policy]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total + self.firstUri = firstUri + self.lastUri = lastUri + self.selfUri = selfUri self.nextUri = nextUri self.previousUri = previousUri - self.lastUri = lastUri + self.pageCount = pageCount + } + + +} + + + + +public class PolicyErrors: Codable { + + + + public var policyErrorMessages: [PolicyErrorMessage]? + + public init(policyErrorMessages: [PolicyErrorMessage]?) { + self.policyErrorMessages = policyErrorMessages + } + + +} + + + +/** Definition of an Action to be created or updated. */ + +public class PostActionInput: Codable { + + + + + + + + + + + + + + /** Category of action, Can be up to 256 characters long */ + public var category: String? + /** Name of action, Can be up to 256 characters long */ + public var name: String? + /** The ID of the integration this action is associated to */ + public var integrationId: String? + /** Configuration to support request and response processing */ + public var config: ActionConfig? + /** Action contract */ + public var contract: ActionContractInput? + /** Indication of whether or not the action is designed to accept sensitive data */ + public var secure: Bool? + + public init(category: String?, name: String?, integrationId: String?, config: ActionConfig?, contract: ActionContractInput?, secure: Bool?) { + self.category = category + self.name = name + self.integrationId = integrationId + self.config = config + self.contract = contract + self.secure = secure + } + + +} + + + + +public class PresenceEventUserPresence: Codable { + + + + + + + + + + + + public var source: String? + public var presenceDefinition: PresenceEventOrganizationPresence? + public var primary: Bool? + public var message: String? + public var modifiedDate: Date? + + public init(source: String?, presenceDefinition: PresenceEventOrganizationPresence?, primary: Bool?, message: String?, modifiedDate: Date?) { + self.source = source + self.presenceDefinition = presenceDefinition + self.primary = primary + self.message = message + self.modifiedDate = modifiedDate + } + + +} + + + + +public class ProgramJob: Codable { + + + + public enum State: String, Codable { + case running = "Running" + case completed = "Completed" + case failed = "Failed" + } + + + + + + + + + + + + /** The globally unique identifier for the object. */ + public var _id: String? + public var state: State? + public var programs: [BaseProgramEntity]? + public var createdBy: AddressableEntityRef? + /** Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateCreated: Date? + /** Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z */ + public var dateModified: Date? + /** The URI for this object */ + public var selfUri: String? + + public init(_id: String?, state: State?, programs: [BaseProgramEntity]?, createdBy: AddressableEntityRef?, dateCreated: Date?, dateModified: Date?, selfUri: String?) { + self._id = _id + self.state = state + self.programs = programs + self.createdBy = createdBy + self.dateCreated = dateCreated + self.dateModified = dateModified + self.selfUri = selfUri + } + + public enum CodingKeys: String, CodingKey { + case _id = "id" + case state + case programs + case createdBy + case dateCreated + case dateModified + case selfUri + } + + +} + + + + +public class ProgramJobRequest: Codable { + + + + /** The ids of the programs used for this job */ + public var programIds: [String]? + + public init(programIds: [String]?) { + self.programIds = programIds + } + + +} + + + + +public class ProgramsMappingsEntityListing: Codable { + + + + + + + + + + + + public var entities: [ProgramMappings]? + public var pageSize: Int? + public var selfUri: String? + public var pageCount: Int? + public var nextUri: String? + + public init(entities: [ProgramMappings]?, pageSize: Int?, selfUri: String?, pageCount: Int?, nextUri: String?) { + self.entities = entities + self.pageSize = pageSize + self.selfUri = selfUri + self.pageCount = pageCount + self.nextUri = nextUri + } + + +} + + + + +public class PromptAssetEntityListing: Codable { + + + + + + + + + + + + + + + + + + + + + + public var entities: [PromptAsset]? + public var pageSize: Int? + public var pageNumber: Int? + public var total: Int64? + public var firstUri: String? + public var lastUri: String? + public var selfUri: String? + public var nextUri: String? + public var previousUri: String? + public var pageCount: Int? + + public init(entities: [PromptAsset]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { + self.entities = entities + self.pageSize = pageSize + self.pageNumber = pageNumber + self.total = total self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -34277,23 +34413,23 @@ public class RecipientListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Recipient]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Recipient]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -34734,24 +34870,24 @@ public class RelationshipListing: Codable { public var pageNumber: Int? public var total: Int64? public var partialResults: Bool? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Relationship]?, pageSize: Int?, pageNumber: Int?, total: Int64?, partialResults: Bool?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Relationship]?, pageSize: Int?, pageNumber: Int?, total: Int64?, partialResults: Bool?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.partialResults = partialResults - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -35361,23 +35497,23 @@ public class ResponseEntityList: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [ModelResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [ModelResponse]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -36493,23 +36629,23 @@ public class ScriptEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Script]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Script]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -36958,23 +37094,23 @@ public class ShareEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Share]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Share]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -38705,23 +38841,23 @@ public class SystemPromptAssetEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [SystemPromptAsset]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [SystemPromptAsset]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -40168,24 +40304,24 @@ public class TrunkMetabaseEntityListing: Codable { public var total: Int64? /** The total organization-wide number of entities. */ public var totalNumberOfEntities: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [Metabase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [Metabase]?, pageSize: Int?, pageNumber: Int?, total: Int64?, totalNumberOfEntities: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total self.totalNumberOfEntities = totalNumberOfEntities - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -41463,23 +41599,23 @@ public class UserAppEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UserApp]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UserApp]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -41609,23 +41745,23 @@ public class UserLanguageEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [UserRoutingLanguage]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [UserRoutingLanguage]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -42223,26 +42359,6 @@ public class V2ConversationMessageTypingEventForUserTopicConversationMessagingFr -public class V2ConversationMessageTypingEventForWorkflowTopicMessageData: Codable { - - - - - - public var conversationId: String? - public var normalizedMessage: V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage? - - public init(conversationId: String?, normalizedMessage: V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage?) { - self.conversationId = conversationId - self.normalizedMessage = normalizedMessage - } - - -} - - - - public class V2ConversationMessageTypingEventForWorkflowTopicConversationMessagingToRecipient: Codable { @@ -42302,6 +42418,26 @@ public class V2ConversationMessageTypingEventForWorkflowTopicConversationMessagi +public class V2ConversationMessageTypingEventForWorkflowTopicMessageData: Codable { + + + + + + public var conversationId: String? + public var normalizedMessage: V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage? + + public init(conversationId: String?, normalizedMessage: V2ConversationMessageTypingEventForWorkflowTopicConversationNormalizedMessage?) { + self.conversationId = conversationId + self.normalizedMessage = normalizedMessage + } + + +} + + + + public class V2FlowExecutionDataFlowidTopicFlowErrorWarningInfo: Codable { @@ -43874,6 +44010,29 @@ public class WfmBulkShiftTradeStateUpdateNotificationTopicWfmVersionedEntityMeta +/** User information for a WhatsApp account */ + +public class WhatsAppId: Codable { + + + + + + /** The phone number associated with this WhatsApp account */ + public var phoneNumber: PhoneNumber? + /** The displayName of this person's account in WhatsApp */ + public var displayName: String? + + public init(phoneNumber: PhoneNumber?, displayName: String?) { + self.phoneNumber = phoneNumber + self.displayName = displayName + } + + +} + + + public class WfmHistoricalAdherenceBulkUserDayMetrics: Codable { @@ -44313,6 +44472,34 @@ public class WfmUserNotificationTopicManagementUnit: Codable { +/** A WhatsApp messaging template definition as defined in the WhatsApp Business Manager */ + +public class WhatsAppDefinition: Codable { + + + + + + + + /** The messaging template name. */ + public var name: String? + /** The messaging template namespace. */ + public var namespace: String? + /** The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US' */ + public var language: String? + + public init(name: String?, namespace: String?, language: String?) { + self.name = name + self.namespace = namespace + self.language = language + } + + +} + + + public class WfmUserNotificationTopicTimeOffRequestNotification: Codable { @@ -44500,34 +44687,6 @@ public class WfmUserScheduleAdherenceUpdatedTeamTopicRealTimeAdherenceExplanatio -/** A WhatsApp messaging template definition as defined in the WhatsApp Business Manager */ - -public class WhatsAppDefinition: Codable { - - - - - - - - /** The messaging template name. */ - public var name: String? - /** The messaging template namespace. */ - public var namespace: String? - /** The messaging template language configured for this template. This is a WhatsApp specific value. For example, 'en_US' */ - public var language: String? - - public init(name: String?, namespace: String?, language: String?) { - self.name = name - self.namespace = namespace - self.language = language - } - - -} - - - public class WfmUserScheduleAdherenceUpdatedTeamTopicUserNextActivityReminder: Codable { @@ -44588,29 +44747,6 @@ public class WfmUserScheduleAdherenceUpdatedTopicSecondaryPresenceReference: Cod -/** User information for a WhatsApp account */ - -public class WhatsAppId: Codable { - - - - - - /** The phone number associated with this WhatsApp account */ - public var phoneNumber: PhoneNumber? - /** The displayName of this person's account in WhatsApp */ - public var displayName: String? - - public init(phoneNumber: PhoneNumber?, displayName: String?) { - self.phoneNumber = phoneNumber - self.displayName = displayName - } - - -} - - - public class WhatsAppIntegrationEntityListing: Codable { @@ -44638,23 +44774,23 @@ public class WhatsAppIntegrationEntityListing: Codable { public var pageSize: Int? public var pageNumber: Int? public var total: Int64? - public var nextUri: String? - public var previousUri: String? - public var lastUri: String? public var firstUri: String? + public var lastUri: String? public var selfUri: String? + public var nextUri: String? + public var previousUri: String? public var pageCount: Int? - public init(entities: [WhatsAppIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, nextUri: String?, previousUri: String?, lastUri: String?, firstUri: String?, selfUri: String?, pageCount: Int?) { + public init(entities: [WhatsAppIntegration]?, pageSize: Int?, pageNumber: Int?, total: Int64?, firstUri: String?, lastUri: String?, selfUri: String?, nextUri: String?, previousUri: String?, pageCount: Int?) { self.entities = entities self.pageSize = pageSize self.pageNumber = pageNumber self.total = total - self.nextUri = nextUri - self.previousUri = previousUri - self.lastUri = lastUri self.firstUri = firstUri + self.lastUri = lastUri self.selfUri = selfUri + self.nextUri = nextUri + self.previousUri = previousUri self.pageCount = pageCount } @@ -45135,8 +45271,6 @@ public class WorkitemCreate: Codable { public var queueId: String? /** The ID of the assignee of the Workitem. Must be a valid UUID. */ public var assigneeId: String? - /** A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. */ - public var scoredAgents: [WorkitemScoredAgentRequest]? /** The ID of language of the Workitem. Must be a valid UUID. */ public var languageId: String? /** The ID of the external contact of the Workitem. Must be a valid UUID. */ @@ -45145,14 +45279,16 @@ public class WorkitemCreate: Codable { public var externalTag: String? /** The skill IDs of the Workitem. Must be valid UUIDs. */ public var skillIds: [String]? - /** The preferred agent IDs of the Workitem. Must be valid UUIDs. */ - public var preferredAgentIds: [String]? /** The ID of the wrapup. Must be a valid UUID. */ public var wrapupCode: String? /** The ID of utilization label of the Workitem. Must be a valid UUID. */ public var utilizationLabelId: String? + /** A list of scored agents for the Workitem. A workitem can have a maximum of 20 scored agents. */ + public var scoredAgents: [WorkitemScoredAgentRequest]? + /** The preferred agent IDs of the Workitem. Must be valid UUIDs. */ + public var preferredAgentIds: [String]? - public init(name: String?, priority: Int?, dateDue: Date?, dateExpires: Date?, durationSeconds: Int?, ttl: Int?, statusId: String?, workbinId: String?, autoStatusTransition: Bool?, _description: String?, typeId: String?, customFields: [String:JSON]?, queueId: String?, assigneeId: String?, scoredAgents: [WorkitemScoredAgentRequest]?, languageId: String?, externalContactId: String?, externalTag: String?, skillIds: [String]?, preferredAgentIds: [String]?, wrapupCode: String?, utilizationLabelId: String?) { + public init(name: String?, priority: Int?, dateDue: Date?, dateExpires: Date?, durationSeconds: Int?, ttl: Int?, statusId: String?, workbinId: String?, autoStatusTransition: Bool?, _description: String?, typeId: String?, customFields: [String:JSON]?, queueId: String?, assigneeId: String?, languageId: String?, externalContactId: String?, externalTag: String?, skillIds: [String]?, wrapupCode: String?, utilizationLabelId: String?, scoredAgents: [WorkitemScoredAgentRequest]?, preferredAgentIds: [String]?) { self.name = name self.priority = priority self.dateDue = dateDue @@ -45167,14 +45303,14 @@ public class WorkitemCreate: Codable { self.customFields = customFields self.queueId = queueId self.assigneeId = assigneeId - self.scoredAgents = scoredAgents self.languageId = languageId self.externalContactId = externalContactId self.externalTag = externalTag self.skillIds = skillIds - self.preferredAgentIds = preferredAgentIds self.wrapupCode = wrapupCode self.utilizationLabelId = utilizationLabelId + self.scoredAgents = scoredAgents + self.preferredAgentIds = preferredAgentIds } public enum CodingKeys: String, CodingKey { @@ -45192,14 +45328,14 @@ public class WorkitemCreate: Codable { case customFields case queueId case assigneeId - case scoredAgents case languageId case externalContactId case externalTag case skillIds - case preferredAgentIds case wrapupCode case utilizationLabelId + case scoredAgents + case preferredAgentIds } diff --git a/notificationMappings.json b/notificationMappings.json index 92d3fdf00..52ec194ac 100644 --- a/notificationMappings.json +++ b/notificationMappings.json @@ -576,6 +576,10 @@ "topic": "v2.users.{id}.outofoffice", "class": "OutOfOfficeEventOutOfOffice" }, + { + "topic": "v2.users.{id}.persistentconnection", + "class": "PersistentConnectionChangeTopicPersistentConnectionChangeEvent" + }, { "topic": "v2.users.{id}.presence", "class": "PresenceEventUserPresence" diff --git a/releaseNotes.md b/releaseNotes.md index 5e6d07d49..f459a3f02 100644 --- a/releaseNotes.md +++ b/releaseNotes.md @@ -1,327 +1,233 @@ -Platform API version: 8669 +Platform API version: 8698 -# Major Changes (9 changes) +# Major Changes (8 changes) -**/api/v2/routing/sms/phonenumbers/{addressId}** (1 change) +**GET /api/v2/externalcontacts/contacts/{contactId}/identifiers** (1 change) -* Path /api/v2/routing/sms/phonenumbers/{addressId} was removed +* Response 200 type was changed from EntityListing to ContactIdentifierListing -**GET /api/v2/knowledge/integrations/{integrationId}/options** (1 change) +**GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests** (1 change) -* Parameter knowledgeBaseIds was added +* Parameter recentlyReviewed was removed -**GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime** (1 change) +**GET /api/v2/workforcemanagement/timeoffrequests** (1 change) -* Parameter labelId was added +* Parameter recentlyReviewed was removed -**GET /api/v2/quality/agents/activity** (1 change) +**QuestionGroupSettings** (1 change) -* Parameter userState was added +* Property questionGroupIndex was removed -**GET /api/v2/quality/evaluations/query** (1 change) +**QuestionSettings** (1 change) -* Parameter includeDeletedUsers was added +* Property questionIndex was removed -**CampaignSchedule** (1 change) +**BatchDownloadJobResult** (3 changes) -* Property campaign was changed from DomainEntityRef to DivisionedDomainEntityRef +* Property id was removed +* Property name was removed +* Property selfUri was removed -**EmailCampaignSchedule** (1 change) -* Property emailCampaign was changed from DomainEntityRef to DivisionedDomainEntityRef +# Minor Changes (50 changes) -**MessagingCampaignSchedule** (1 change) - -* Property messagingCampaign was changed from DomainEntityRef to DivisionedDomainEntityRef - -**ValidationServiceRequest** (1 change) - -* Property fileName was removed - - -# Minor Changes (68 changes) - -**/api/v2/conversations/{conversationId}/summaries** (2 changes) +**/api/v2/externalcontacts/import/jobs/{jobId}** (3 changes) * Path was added * Operation GET was added +* Operation PUT was added -**/api/v2/usage/events/query** (2 changes) - -* Path was added -* Operation POST was added - -**/api/v2/usage/events/aggregates/query** (2 changes) +**/api/v2/externalcontacts/import/jobs** (3 changes) * Path was added +* Operation GET was added * Operation POST was added -**POST /api/v2/routing/email/domains/{domainName}/routes** (1 change) - -* Response 202 was added - -**/api/v2/routing/sms/phonenumbers/{phoneNumberId}** (4 changes) +**/api/v2/externalcontacts/import/settings/{settingsId}** (4 changes) * Path was added * Operation GET was added * Operation PUT was added * Operation DELETE was added -**GET /api/v2/voicemail/me/mailbox** (1 change) - -* Response 502 was added - -**OrgAuthSettings** (1 change) - -* Optional property inactivityTimeoutExclusions was added - -**AgentCopilotAggregateQueryPredicate** (1 change) - -* Enum value hasAnswerHighlight was added to property dimension +**/api/v2/externalcontacts/import/settings** (3 changes) -**AgentCopilotAggregationQuery** (1 change) - -* Enum value hasAnswerHighlight was added to property groupBy - -**ViewFilter** (2 changes) - -* Enum value apple was added to property messageTypes -* Optional property conferenced was added - -**ReportingExportJobResponse** (1 change) - -* Enum value AGENT_COPILOT_PERFORMANCE_VIEW was added to property viewType - -**ReportingExportMetadataJobResponse** (1 change) - -* Enum value AGENT_COPILOT_PERFORMANCE_VIEW was added to property viewType - -**ReportingExportJobRequest** (1 change) - -* Enum value AGENT_COPILOT_PERFORMANCE_VIEW was added to property viewType - -**EvaluationForm** (1 change) - -* Optional property evaluationSettings was added - -**EvaluationSettings** (4 changes) - -* Optional property revisionsEnabled was added -* Optional property disputesEnabled was added -* Optional property disputesAllowedPerEvaluation was added -* Optional property disputesAssignees was added +* Path was added +* Operation GET was added +* Operation POST was added -**EvaluationSettingsAssignee** (2 changes) +**/api/v2/dataprivacy/maskingrules/{ruleId}** (4 changes) -* Optional property user was added -* Optional property type was added +* Path was added +* Operation GET was added +* Operation DELETE was added +* Operation PATCH was added -**WrapupCode** (1 change) +**/api/v2/dataprivacy/maskingrules** (3 changes) -* Optional property description was added +* Path was added +* Operation GET was added +* Operation POST was added -**Session** (1 change) +**/api/v2/dataprivacy/maskingrules/validate** (2 changes) -* Optional property divisionIds was added +* Path was added +* Operation POST was added -**ConversationEventTyping** (1 change) +**PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}** (1 change) -* duration is no longer readonly +* Response 202 was added -**MessagingIntegration** (1 change) +**DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}** (1 change) -* Enum value Failed was added to property status +* Response 202 was added -**OpenMessagingIdentityResolutionConfig** (1 change) +**ContactIdentifierListing** (1 change) * Model was added -**WhatsAppIntegration** (1 change) +**ContactImportJobStatusUpdateResponse** (1 change) -* Enum value Failed was added to property status +* Model was added -**ConversationEditedSummary** (1 change) +**ContactImportJobStatusUpdateRequest** (1 change) * Model was added -**ConversationSessionSummary** (1 change) +**ContactImportJobMetadata** (1 change) * Model was added -**ConversationSummariesGetResponse** (1 change) +**ContactImportJobResponse** (1 change) * Model was added -**ConversationSummary** (1 change) +**ContactImportJobRequest** (1 change) * Model was added -**ConversationSummaryFollowup** (1 change) +**ContactImportJobEntityListing** (1 change) * Model was added -**ConversationSummaryReason** (1 change) +**ContactImportField** (1 change) * Model was added -**ConversationSummaryResolution** (1 change) +**ContactImportSettings** (1 change) * Model was added -**ConversationSummaryWrapupCode** (1 change) +**ContactImportSettingsEntityListing** (1 change) * Model was added -**CampaignRuleCondition** (1 change) +**ConversationMessageMetadataContent** (1 change) -* Enum value campaignContactsMessaged was added to property conditionType +* Enum value DatePicker was added to property contentType -**CampaignRuleWarningParameters** (1 change) +**ConversationContentButtonResponse** (1 change) -* Enum value campaignContactsMessaged was added to property conditionType +* Enum value DatePicker was added to property type -**DivisionedDomainEntityRef** (1 change) +**ConversationContentDatePicker** (1 change) * Model was added -**JourneyViewElement** (1 change) - -* Optional property displayAttributes was added - -**JourneyViewElementDisplayAttributes** (1 change) +**ConversationContentDatePickerAvailableTime** (1 change) * Model was added -**KnowledgeIntegrationFilter** (1 change) +**ConversationMessageContent** (1 change) -* Optional property action was added - -**KnowledgeExportJobDocumentsFilter** (1 change) - -* Optional property includeDocumentsWithFileBody was added - -**Miner** (1 change) - -* Enum value nl-nl was added to property language - -**KnowledgeGuestSession** (1 change) - -* Optional property journeySessionId was added - -**EventQueryResponse** (1 change) - -* Model was added +* Enum value DatePicker was added to property contentType -**OperationalEvent** (1 change) +**MaskingRule** (1 change) * Model was added -**EventQueryRequest** (1 change) +**MaskingRuleListing** (1 change) * Model was added -**EventAggregatesResponse** (1 change) +**MaskingRuleValidateResponse** (1 change) * Model was added -**EventDefinitionAggregates** (1 change) +**MaskingRuleValidateRequest** (1 change) * Model was added -**EventAggregatesQueryRequest** (1 change) +**KnowledgeIntegrationDefaultSettings** (1 change) * Model was added -**PredictionResults** (1 change) +**SalesforceSettings** (1 change) -* Optional property label was added +* Optional property baseUrl was added -**BatchDownloadJobStatusResult** (1 change) +**ServiceNowSettings** (1 change) -* Optional property status was added +* Optional property baseUrl was added -**EvaluationFormResponse** (1 change) +**RegionTimeZone** (1 change) -* Optional property evaluationSettings was added +* Optional property canonicalId was added -**WrapupCodeRequest** (1 change) +**Dependency** (1 change) -* Optional property description was added +* Enum value SMSPHONENUMBER was added to property type -**ScimV2EnterpriseUser** (1 change) +**DependencyObject** (1 change) -* Optional property dateHire was added +* Enum value SMSPHONENUMBER was added to property type -**UserMe** (1 change) +**CobrowseSettings** (1 change) -* Optional property autoAnswerSettings was added - -**ArchitectJobStateResponse** (1 change) - -* Enum value Export was added to property command - -**SupportCenterLabelFilter** (1 change) - -* Model was added - -**SupportCenterSettings** (1 change) - -* Optional property labelFilter was added - -**WorkitemScriptReference** (1 change) - -* Model was added - -**WorkitemOnAttributeChangeRule** (1 change) - -* Enum value Date was added to property type - -**WorkitemOnCreateRule** (1 change) - -* Enum value Date was added to property type +* Optional property allowDraw was added # Point Changes (10 changes) -**GET /api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns** (1 change) +**GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest** (1 change) * Description was changed -**GET /api/v2/analytics/botflows/{botFlowId}/reportingturns** (1 change) +**GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}** (1 change) * Description was changed -**GET /api/v2/analytics/botflows/{botFlowId}/sessions** (1 change) +**PATCH /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}** (1 change) * Description was changed -**POST /api/v2/routing/email/domains/{domainName}/routes** (1 change) +**POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs** (1 change) -* Response 200 was changed from successful operation to Route create completed. +* Description was changed -**POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search** (1 change) +**GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results** (1 change) -* Description was changed for parameter weekDateId +* Description was changed -**GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades** (1 change) +**GET /api/v2/journey/views/{viewId}/schedules** (1 change) -* Description was changed for parameter weekDateId +* Description was changed -**POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades** (1 change) +**PUT /api/v2/journey/views/{viewId}/schedules** (1 change) -* Description was changed for parameter weekDateId +* Description was changed -**POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk** (1 change) +**DELETE /api/v2/journey/views/{viewId}/schedules** (1 change) -* Description was changed for parameter weekDateId +* Description was changed -**PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}** (1 change) +**PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId}** (1 change) -* Description was changed for parameter weekDateId +* Response 200 was changed from successful operation to Route update completed. -**POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match** (1 change) +**DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId}** (1 change) -* Description was changed for parameter weekDateId +* Response 200 was changed from Operation was successful. to Route deletion completed. diff --git a/swagger.json b/swagger.json index 10b14ae19..6c09a4d44 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":"Identity Provider","description":"Identity providers","externalDocs":{"description":"Identity Providers Documentation","url":"https://developer.genesys.cloud/authorization/oauth-apis/identityprovider/"}},{"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":"Organization","description":"Organization","externalDocs":{"description":"Organization Documentation","url":"https://developer.genesys.cloud/organization/organization/"}},{"name":"Tokens","description":"Authentication Tokens","externalDocs":{"description":"Tokens Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/tokens/"}},{"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":"Agent UI","description":"Agent UI settings and configuration"},{"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":"Agent Assistants","description":"Manage virtual agent assistants."},{"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":"Employee Engagement","description":"Employee Engagement","externalDocs":{"description":"Employee Engagement Documentation","url":"https://developer.genesys.cloud/useragentman/employeeengagement/"}},{"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":"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 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":"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"},{"name":"Agent Copilot","description":"Manage agent copilot configuration."}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/users/agentui/agents/autoanswer/{agentId}/settings":{"get":{"tags":["Agent UI","Settings"],"summary":"Get agent auto answer settings","description":"","operationId":"getUsersAgentuiAgentsAutoanswerAgentIdSettings","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent to apply the auto answer settings to","required":true,"type":"string"}],"responses":{"200":{"description":"Auto answer settings retrieved successfully","schema":{"$ref":"#/definitions/AutoAnswerSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["agentUI:agents:view"]},"x-purecloud-method-name":"getUsersAgentuiAgentsAutoanswerAgentIdSettings"},"put":{"tags":["Agent UI","Settings"],"summary":"Set agent auto answer settings","description":"","operationId":"putUsersAgentuiAgentsAutoanswerAgentIdSettings","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent to apply the auto answer settings to","required":true,"type":"string"},{"in":"body","name":"body","description":"AutoAnswerSettings","required":true,"schema":{"$ref":"#/definitions/AutoAnswerSettings"}}],"responses":{"200":{"description":"Auto answer settings set successfully","schema":{"$ref":"#/definitions/AutoAnswerSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["agentUI:agents:edit"]},"x-purecloud-method-name":"putUsersAgentuiAgentsAutoanswerAgentIdSettings"},"delete":{"tags":["Agent UI","Settings"],"summary":"Delete agent auto answer settings","description":"","operationId":"deleteUsersAgentuiAgentsAutoanswerAgentIdSettings","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent to apply the auto answer settings to","required":true,"type":"string"}],"responses":{"204":{"description":"Auto answer settings 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["agentUI:agents:delete"]},"x-purecloud-method-name":"deleteUsersAgentuiAgentsAutoanswerAgentIdSettings"},"patch":{"tags":["Agent UI","Settings"],"summary":"Update agent auto answer settings","description":"","operationId":"patchUsersAgentuiAgentsAutoanswerAgentIdSettings","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent to apply the auto answer settings to","required":true,"type":"string"},{"in":"body","name":"body","description":"AutoAnswerSettings","required":true,"schema":{"$ref":"#/definitions/AutoAnswerSettings"}}],"responses":{"200":{"description":"Auto answer settings updated successfully","schema":{"$ref":"#/definitions/AutoAnswerSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["agentUI:agents:edit"]},"x-purecloud-method-name":"patchUsersAgentuiAgentsAutoanswerAgentIdSettings"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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).","general.forbidden":"Forbidden to create an interaction stats rule.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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 reach 90% of the maximum. 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. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. It is expected that the client will URL encode the request URI once only. 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. The 'nextUri' value in the response is already URL encoded (so it doesn't need to be encoded again). 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","SkippedCollection","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. It is expected that the client will URL encode the request URI once only. 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. The 'nextUri' value in the response is already URL encoded (so it doesn't need to be encoded again). 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","SkippedCollection","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. It is expected that the client will URL encode the request URI once only. 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. The 'nextUri' value in the response is already URL encoded (so it doesn't need to be encoded again). 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 soft delete 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"name","in":"query","description":"name of the dashboard","required":false,"type":"string"},{"name":"dashboardType","in":"query","description":"List dashboard of given type","required":true,"type":"string","enum":["All","Public","Private","Shared","Favorites","Deleted"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 soft 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]},{"name":"deletedOnly","in":"query","description":"Only list deleted dashboards that are still recoverable","required":false,"type":"boolean"}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"deletedOnly","in":"query","description":"If true, retrieve only deleted dashboards that are still recoverable","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/assistants/{assistantId}/copilot":{"get":{"tags":["Agent Copilot"],"summary":"Get copilot configuration of an assistant.","description":"","operationId":"getAssistantCopilot","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Copilot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:copilot:view"]},"x-purecloud-method-name":"getAssistantCopilot"},"put":{"tags":["Agent Copilot"],"summary":"Update agent copilot configuration","description":"","operationId":"putAssistantCopilot","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Copilot"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Copilot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:copilot:edit"]},"x-purecloud-method-name":"putAssistantCopilot"}},"/api/v2/assistants/{assistantId}/queues/{queueId}":{"get":{"tags":["Agent Assistants"],"summary":"Get queue Information for an assistant.","description":"","operationId":"getAssistantQueue","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["assistant"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:view"]},"x-purecloud-method-name":"getAssistantQueue"},"put":{"tags":["Agent Assistants"],"summary":"Create a queue assistant association.","description":"","operationId":"putAssistantQueue","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/AssistantQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueue"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/AssistantQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:edit"]},"x-purecloud-method-name":"putAssistantQueue"},"delete":{"tags":["Agent Assistants"],"summary":"Disassociate a queue from an assistant.","description":"","operationId":"deleteAssistantQueue","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:delete"]},"x-purecloud-method-name":"deleteAssistantQueue"}},"/api/v2/assistants/{assistantId}/queues":{"get":{"tags":["Agent Assistants"],"summary":"Get all the queues associated with an assistant.","description":"","operationId":"getAssistantQueues","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant 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":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["assistant"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueueListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:view"]},"x-purecloud-method-name":"getAssistantQueues"},"delete":{"tags":["Agent Assistants"],"summary":"Disassociate the queues from an assistant for the given assistant ID and queue IDs.","description":"","operationId":"deleteAssistantQueues","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"queueIds","in":"query","description":"Comma-separated identifiers of the queues that need to be deleted.","required":false,"type":"string"}],"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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","conflict":"Deleting queues from an assistant 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":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:delete"]},"x-purecloud-method-name":"deleteAssistantQueues"},"patch":{"tags":["Agent Assistants"],"summary":"Update Queues for an Assistant.","description":"","operationId":"patchAssistantQueues","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/AssistantQueue"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueueListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:edit"]},"x-purecloud-method-name":"patchAssistantQueues"}},"/api/v2/assistants/{assistantId}":{"get":{"tags":["Agent Assistants"],"summary":"Get an assistant.","description":"","operationId":"getAssistant","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["copilot"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assistant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:view"]},"x-purecloud-method-name":"getAssistant"},"delete":{"tags":["Agent Assistants"],"summary":"Delete an assistant.","description":"","operationId":"deleteAssistant","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"}],"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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:delete"]},"x-purecloud-method-name":"deleteAssistant"},"patch":{"tags":["Agent Assistants"],"summary":"Update an assistant.","description":"","operationId":"patchAssistant","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Assistant"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assistant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:edit"]},"x-purecloud-method-name":"patchAssistant"}},"/api/v2/assistants":{"get":{"tags":["Agent Assistants"],"summary":"Get all assistants.","description":"","operationId":"getAssistants","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":"name","in":"query","description":"Return the assistant by the given name.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:view"]},"x-purecloud-method-name":"getAssistants"},"post":{"tags":["Agent Assistants"],"summary":"Create an Assistant.","description":"","operationId":"postAssistants","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Assistant"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assistant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:add"]},"x-purecloud-method-name":"postAssistants"}},"/api/v2/assistants/queues":{"get":{"tags":["Agent Assistants"],"summary":"Get all queues assigned to any assistant.","description":"","operationId":"getAssistantsQueues","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":"queueIds","in":"query","description":"Comma-separated identifiers of the queues that need to be retrieved.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["assistant"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueueListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:view"]},"x-purecloud-method-name":"getAssistantsQueues"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"allowRedirect","in":"query","description":"Result sets with large amounts of data will respond with a download url","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionResultsResponse"}},"302":{"description":"Result set too large to be returned in the response. Please use the returned download url or reduce the page size. Downloaded results will not be expanded.","schema":{"$ref":"#/definitions/AuditQueryExecutionLargeResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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]","insufficient.permissions":"Insufficient permissions to assign a list of objects to a 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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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":["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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/UserReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/settings":{"get":{"tags":["Authorization"],"summary":"Get authorization role settings","description":"","operationId":"getAuthorizationRolesSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoleSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getAuthorizationRolesSettings"},"put":{"tags":["Authorization"],"summary":"Change authorization role settings","description":"Change role settings","operationId":"putAuthorizationRolesSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Authorization Role Settings","required":true,"schema":{"$ref":"#/definitions/RoleSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoleSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"putAuthorizationRolesSettings"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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]","max.roles.exceeded":"Cannot create role because maximum number of role is exceeded.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","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","request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","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","request.conflict":"The request conflicts with the current state of the target resource.","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","forbidden":"Forbidden from removing a user from a room.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources","identifiers","externalSources","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"identifier.claim.conflict":"Identifier is already claimed","request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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","identifiers","externalSources","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","identifiers","externalSources","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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/externalsources/{externalSourceId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an External Source","description":"","operationId":"getExternalcontactsExternalsource","produces":["application/json"],"parameters":[{"name":"externalSourceId","in":"path","description":"External Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 source not found by external source 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:externalSource:view","externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsExternalsource"},"put":{"tags":["External Contacts"],"summary":"Update an External Source","description":"","operationId":"putExternalcontactsExternalsource","produces":["application/json"],"parameters":[{"name":"externalSourceId","in":"path","description":"External Source ID","required":true,"type":"string"},{"in":"body","name":"body","description":"External Source","required":true,"schema":{"$ref":"#/definitions/ExternalSource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 source not found by external source 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","active.external.source.limit.reached":"The number of active External Sources in org limit reached","external.source.exists":"External Source with 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."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided external source data 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:externalSource:edit"]},"x-purecloud-method-name":"putExternalcontactsExternalsource"},"delete":{"tags":["External Contacts"],"summary":"Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.","description":"","operationId":"deleteExternalcontactsExternalsource","produces":["application/json"],"parameters":[{"name":"externalSourceId","in":"path","description":"External Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"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":{"entity.not.found":"External source not found by external source 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:externalSource:delete"]},"x-purecloud-method-name":"deleteExternalcontactsExternalsource"}},"/api/v2/externalcontacts/externalsources":{"get":{"tags":["External Contacts"],"summary":"Fetch a list of External Sources","description":"","operationId":"getExternalcontactsExternalsources","produces":["application/json"],"parameters":[{"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"},{"name":"limit","in":"query","description":"The number of ExternalSources per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"name","in":"query","description":"Filter by external source name. Filtering is prefix filtering and not an exact match","required":false,"type":"string"},{"name":"active","in":"query","description":"Filter by active status of external source","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorExternalSourceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:externalSource:view","externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsExternalsources"},"post":{"tags":["External Contacts"],"summary":"Create an External Source","description":"","operationId":"postExternalcontactsExternalsources","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"External Source","required":true,"schema":{"$ref":"#/definitions/ExternalSource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","active.external.source.limit.reached":"The number of active External Sources in org limit reached","external.source.exists":"External Source with that name already exists","max.external.source.limit.reached":"The number of total External Sources in org 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."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"Provided External source 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:externalSource:add"]},"x-purecloud-method-name":"postExternalcontactsExternalsources"}},"/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"}},{"name":"expand","in":"query","description":"which field, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","identifiers","externalSources","division"]},"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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources","identifiers","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/externalcontacts/import/csv/jobs":{"post":{"tags":["External Contacts"],"summary":"Create CSV import job","description":"","operationId":"postExternalcontactsImportCsvJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ImportRequest","required":true,"schema":{"$ref":"#/definitions/CsvJobRequest"}}],"responses":{"202":{"description":"Accepted - CSV import job created","schema":{"$ref":"#/definitions/CsvJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.parameter":"Parameter 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","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.error":"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":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:importCsvJob:add"]},"x-purecloud-method-name":"postExternalcontactsImportCsvJobs"}},"/api/v2/externalcontacts/import/csv/settings/{settingsId}":{"get":{"tags":["External Contacts"],"summary":"Get settings for CSV import","description":"","operationId":"getExternalcontactsImportCsvSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CsvSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:view"]},"x-purecloud-method-name":"getExternalcontactsImportCsvSetting"},"put":{"tags":["External Contacts"],"summary":"Update settings for CSV import","description":"","operationId":"putExternalcontactsImportCsvSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"},{"in":"body","name":"body","description":"Settings","required":true,"schema":{"$ref":"#/definitions/CsvSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CsvSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.settings":"Invalid settings","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:edit"]},"x-purecloud-method-name":"putExternalcontactsImportCsvSetting"},"delete":{"tags":["External Contacts"],"summary":"Delete settings for CSV import","description":"","operationId":"deleteExternalcontactsImportCsvSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"}],"responses":{"204":{"description":"Settings 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:delete"]},"x-purecloud-method-name":"deleteExternalcontactsImportCsvSetting"}},"/api/v2/externalcontacts/import/csv/settings":{"get":{"tags":["External Contacts"],"summary":"Retrieve all settings for organization filtered by externalSettingsId if provided","description":"","operationId":"getExternalcontactsImportCsvSettings","produces":["application/json"],"parameters":[{"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":"externalSettingsId","in":"query","description":"External Settings Id to filter the list.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Listing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:view"]},"x-purecloud-method-name":"getExternalcontactsImportCsvSettings"},"post":{"tags":["External Contacts"],"summary":"Create settings for CSV import","description":"","operationId":"postExternalcontactsImportCsvSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Settings","required":true,"schema":{"$ref":"#/definitions/CsvSettings"}}],"responses":{"201":{"description":"Settings created","schema":{"$ref":"#/definitions/CsvSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","settings.invalid":"Invalid settings","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:add"]},"x-purecloud-method-name":"postExternalcontactsImportCsvSettings"}},"/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details":{"get":{"tags":["External Contacts"],"summary":"Get details for CSV upload","description":"","operationId":"getExternalcontactsImportCsvUploadDetails","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CsvUploadDetailsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvUpload:view"]},"x-purecloud-method-name":"getExternalcontactsImportCsvUploadDetails"}},"/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview":{"get":{"tags":["External Contacts"],"summary":"Get preview for CSV upload","description":"","operationId":"getExternalcontactsImportCsvUploadPreview","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CsvUploadPreviewResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.upload":"Invalid upload"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvUpload:view"]},"x-purecloud-method-name":"getExternalcontactsImportCsvUploadPreview"}},"/api/v2/externalcontacts/import/csv/uploads":{"post":{"tags":["External Contacts"],"summary":"Get url for CSV upload","description":"","operationId":"postExternalcontactsImportCsvUploads","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"UploadRequest","required":true,"schema":{"$ref":"#/definitions/CsvUploadRequest"}}],"responses":{"201":{"description":"Upload initiated","schema":{"$ref":"#/definitions/CsvUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvUpload:add"]},"x-purecloud-method-name":"postExternalcontactsImportCsvUploads"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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":{"request.conflict":"The request conflicts with the current state of the target resource.","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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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","forbidden":"Forbidden from update 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."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided","x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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":"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."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"202":{"description":"Accepted","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":{"general.resource.not.found":"The resource 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","conversation.error.outbound.call.cannot.be.placed":"Outbound call cannot be placed.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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]","conversation.error.multiple.coaches":"Multiple coaches on the conversation.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","conversation.error.outbound.call.cannot.be.placed":"Outbound call cannot be placed."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.reply.sending":"Error sending an email reply.","request.conflict":"The request conflicts with the current state of the target resource.","email.error.communication.conflict":"The email sending has communication conflict error."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/{conversationId}/participants/{participantId}/parkingstate":{"patch":{"tags":["Conversations"],"summary":"Update conversation by setting its parking state","description":"","operationId":"patchConversationsEmailParticipantParkingstate","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":"Parking update request","required":true,"schema":{"$ref":"#/definitions/ParkingStateRequest"}}],"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":{"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.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.unexpected.parking.state":"Unexpected parking state.","conversation.error.park.user.concurrent.max.exceeded":"Park failed because maximum concurrent parked communications 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.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.bad.request":"Bad Request","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:park"]},"x-purecloud-method-name":"patchConversationsEmailParticipantParkingstate"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/CreateOutboundMessagingConversationResponse"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/{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.","conversation.message.limit.exceeded":"Conversation max message limit has been reached.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded.","request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","conversation:socialmedia: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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded.","request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},{"name":"prefetchConversationId","in":"query","description":"Indicates whether or not to prefetch conversationId","required":false,"type":"boolean","default":false},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","integration.has.ingestion.rule":"Facebook integration cannot be deleted with an existing ingestion rule associated to it. Remove associated ingestion rule before deleting integration."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","integration.has.ingestion.rule":"Instagram integration cannot be deleted with an existing ingestion rule associated to it. Remove associated ingestion rule before deleting integration."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","supported.content.in.use.sms":"The supported content profile is in use by an SMS 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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.","conversation.error.disallowed.transfer.destination":"Disallowed transfer 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/suggestions/feedback":{"post":{"tags":["Conversations"],"summary":"Suggestion feedback.","description":"Google Agent Assist offering within Genesys will no longer be supported","operationId":"postConversationSuggestionsFeedback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SuggestionFeedback","required":true,"schema":{"$ref":"#/definitions/Feedback"}}],"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":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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-inin-requires-permissions":{"type":"ANY","permissions":["conversation:suggestionFeedback:add"]},"x-purecloud-method-name":"postConversationSuggestionsFeedback"}},"/api/v2/conversations/{conversationId}/suggestions":{"get":{"tags":["Conversations"],"summary":"Get all suggestions for a conversation.","description":"","operationId":"getConversationSuggestions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation 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":"type","in":"query","description":"Suggestion type to filter by.","required":false,"type":"string","enum":["Faq","Article","KnowledgeArticle","KnowledgeSearch","CannedResponse","Script"]},{"name":"state","in":"query","description":"Suggestion state to filter Copilot suggestions.","required":false,"type":"string","enum":["Suggested","Accepted","Dismissed","Failed","Rated"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SuggestionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:suggestion:view"]},"x-purecloud-method-name":"getConversationSuggestions"}},"/api/v2/conversations/{conversationId}/suggestions/{suggestionId}":{"get":{"tags":["Conversations"],"summary":"Get Suggestion.","description":"","operationId":"getConversationSuggestion","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"suggestionId","in":"path","description":"Suggestion ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Suggestion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:suggestion:view"]},"x-purecloud-method-name":"getConversationSuggestion"}},"/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement":{"post":{"tags":["Conversations"],"summary":"Save an engagement on the suggestion.","description":"","operationId":"postConversationSuggestionEngagement","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"suggestionId","in":"path","description":"Suggestion ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SuggestionEngagement"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SuggestionEngagement"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:suggestionEngagement:add"]},"x-purecloud-method-name":"postConversationSuggestionEngagement"}},"/api/v2/conversations/{conversationId}/summaries":{"get":{"tags":["Conversations"],"summary":"Get the summaries of the conversation.","description":"","operationId":"getConversationSummaries","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationSummariesGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:summary:view"]},"x-purecloud-method-name":"getConversationSummaries"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"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.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","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","flows.datatables.table.not.found":"The specified datatable was not found.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","outbound:campaign:recycle"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"patch":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"patchOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignPatchRequest","required":true,"schema":{"$ref":"#/definitions/CampaignPatchRequest"}}],"responses":{"204":{"description":"The campaign 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":{"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.max.calls.per.agent":"Max calls per agent must be inside allowed range","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.update":"An attempt was made to update the outbound campaign in an invalid 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.","queue.not.found":"The queue could not be found.","resources.in.use":"Resources are already in use.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","invalid.update.wrong.version":"Conflict due to concurrent modification was detected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"patchOutboundCampaign"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/campaigns/{campaignId}/skillcombinations":{"get":{"tags":["Outbound"],"summary":"Get the remaining and total contact count for each skill combination in a skills campaign","description":"","operationId":"getOutboundCampaignSkillcombinations","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign 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/PagedSkillCombinationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"getOutboundCampaignSkillcombinations"}},"/api/v2/outbound/campaigns/{campaignId}/start":{"post":{"tags":["Outbound"],"summary":"Start the campaign","description":"","operationId":"postOutboundCampaignStart","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"OK - The campaign is started"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:start"]},"x-purecloud-method-name":"postOutboundCampaignStart"}},"/api/v2/outbound/campaigns/{campaignId}/stop":{"post":{"tags":["Outbound"],"summary":"Stop the campaign","description":"","operationId":"postOutboundCampaignStop","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"OK - The campaign is stopped"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:stop"]},"x-purecloud-method-name":"postOutboundCampaignStop"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.","conditions.limit.exceeded":"The maximum number of conditions has been exceeded","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.","cannot.modify.campaign.rule.property":"Cannot modify a rule property","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.","invalid.campaign.rule.action.parameter.messages.per.minute":"Parameter messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for messaging campaign type (see documentation)","invalid.campaign.rule.property.value":"Invalid a campaign rule property 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","campaign.rule.entity.incompatible":"Incompatible rule entities","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.","conditions.limit.exceeded":"The maximum number of conditions has been exceeded","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.","invalid.campaign.rule.action.parameter.messages.per.minute":"Parameter messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for messaging campaign type (see documentation)","invalid.campaign.rule.property.value":"Invalid a campaign rule property 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.dialing.mode.update":"Invalid dialing mode specified.","campaign.rule.entity.incompatible":"Incompatible rule entities","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.interval.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 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":"","invalid.update":"An attempt was made to update the 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.attributes.supplied":"The schedule contains unsupported attributes","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","recurrence.alterations.exceeded.limit":"The number of alterations within the recurrence has exceeded the limit","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 must be 'campaigns'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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/jobs":{"get":{"tags":["Outbound"],"summary":"Get 10 most recent bulk operation jobs associated with contact list.","description":"","operationId":"getOutboundContactlistContactsBulkJobs","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsBulkOperationJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"getOutboundContactlistContactsBulkJobs"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId}":{"get":{"tags":["Outbound"],"summary":"Get bulk operation job.","description":"","operationId":"getOutboundContactlistContactsBulkJob","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","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":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"getOutboundContactlistContactsBulkJob"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"An attempt was made to create the 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.","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing the campaign.","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","campaign.sequence.cannot.add.running.campaign.to.on.sequence":"","campaign.sequence.cannot.remove.running.campaign":"","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":"","invalid.update":"An attempt was made to update the schedule in an invalid way","invalid.alteration.type":"The alteration type is a required field and must be a valid alteration type.","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","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.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","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.attributes.supplied":"The schedule contains unsupported attributes","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","recurrence.alterations.exceeded.limit":"The number of alterations within the recurrence has exceeded the limit","campaign.sequence.invalid.campaign":"At least one campaign is invalid","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\"","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","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 must be 'sequences'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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.","campaign.not.found":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","sequence.not.found":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","business.categories.mutually.exclusive":"Business categories are mutually exclusive","business.categories.rpc.required":"Business category requires Right_Party_Contact flag","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","email.reply.to.address.domain.not.found":"The reply-to address domain could not be found","contact.list.not.found":"The contact list could not be found","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)","cannot.update.campaign.type":"The campaign type cannot be updated to a different type configuration","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.contact.list":"A valid contact list must be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","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","invalid.dnc.list":"One or more DNC List references are invalid","email.content.template.not.authorized":"The user does not have authorization to access the content template","email.reply.to.address.route.not.found":"The reply-to address route could not be found","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.callable.time.set":"The provided callable time set is invalid","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)","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","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","client.failed.request":"The 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.filter.mismatch":"The contact list on the contact list filter does not match the one on the campaign","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","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.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","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","sms.content.template.mms.phone.number.type.not.supported":"The Content template with mms is not supported for the sms phone number type","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.","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined","invalid.type.config":"Exactly one of [emailConfig, smsConfig] must be provided","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","duplicate.name":"The name is in use by another messaging campaign","invalid.email.reply.to.address.route.domain":"The reply-to address route must have a reply route domain configured","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.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","invalid.response.asset.type":"The asset type on the response must be valid for the supported content profile configured on the phone number.","invalid.name":"A name must be provided","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","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.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","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.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","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","sms.content.template.mms.not.supported":"The Content template with mms is not supported for the sms phone number","callable.time.set.not.found":"The callable time set could not be found","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)","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.email.content.template.texts":"The content template must contain exactly two response texts","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","sms.content.template.not.found":"The Content template could not be found","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","missing.phone.columns.in.contactlist":"The contact list must have at least one phone number column configured when the campaign is configured for SMS","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","email.content.template.not.found":"The content template could not be found","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.not.authorized":"User doesn't have authorization to access content template","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of 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":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"Documented permissions are applicable based on campaign type.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","outbound:messagingCampaign:recycle","outbound:emailCampaign:recycle"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/{messagingCampaignId}/start":{"post":{"tags":["Outbound"],"summary":"Start the campaign","description":"Documented permissions are applicable based on campaign type.","operationId":"postOutboundMessagingcampaignStart","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"OK - The campaign is started"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:start","outbound:emailCampaign:start"]},"x-purecloud-method-name":"postOutboundMessagingcampaignStart"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop":{"post":{"tags":["Outbound"],"summary":"Stop the campaign","description":"Documented permissions are applicable based on campaign type.","operationId":"postOutboundMessagingcampaignStop","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"OK - The campaign is stopped"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:stop","outbound:emailCampaign:stop"]},"x-purecloud-method-name":"postOutboundMessagingcampaignStop"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.response.asset.type":"The asset type on the response must be valid for the supported content profile configured on the phone number.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.attributes.supplied":"The schedule contains unsupported attributes","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","recurrence.alterations.exceeded.limit":"The number of alterations within the recurrence has exceeded the limit","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.attributes.supplied":"The schedule contains unsupported attributes","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","recurrence.alterations.exceeded.limit":"The number of alterations within the recurrence has exceeded the limit","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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":{"general.resource.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 update group configuration due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.standalone.phone":"Phone ID provided does not exist or is not standalone.","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","x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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]","invalid.standalone.phone":"Phone ID provided does not exist or is not standalone.","group.name.in.use":"This group name is currently in use.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"request.conflict":"The request conflicts with the current state of the target resource.","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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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","externalContactsSettings"]},"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","general.bad.request":"Unable to find the user profile 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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":{"ocelot.not.found":"Ocelot not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/truststore":{"get":{"tags":["Integrations"],"summary":"Retrieves basic info about trusted root CA certificates","description":"","operationId":"getIntegrationsActionsCertificatesTruststore","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustedCertificates"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getIntegrationsActionsCertificatesTruststore"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/audioconnector/{integrationId}":{"get":{"tags":["Integrations"],"summary":"Get an Audio Connector integration","description":"","operationId":"getIntegrationsSpeechAudioconnectorIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AudioConnectorIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getIntegrationsSpeechAudioconnectorIntegrationId"}},"/api/v2/integrations/speech/audioconnector":{"get":{"tags":["Integrations"],"summary":"Get a list of Audio Connector integrations","description":"","operationId":"getIntegrationsSpeechAudioconnector","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/AudioConnectorIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getIntegrationsSpeechAudioconnector"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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"},{"name":"eventType","in":"query","description":"A comma separated list of journey event types to include in the results.","required":false,"type":"string","enum":["com.genesys.journey.OutcomeAchievedEvent","com.genesys.journey.SegmentAssignmentEvent","com.genesys.journey.WebActionEvent","com.genesys.journey.WebEvent","com.genesys.journey.AppEvent"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyView"},"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":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:delete"]},"x-purecloud-method-name":"deleteJourneyView"}},"/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":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViewVersion"},"put":{"tags":["Journey"],"summary":"Update a Journey View by ID and version","description":"does not create a new version","operationId":"putJourneyViewVersion","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"name":"versionId","in":"path","description":"versionId","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":{"limit.exceeded":"Body content has exceeded the authorized limit","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","malformed.value":"Some content of body contains malformed value","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","not.allowed":"Some content of body is not allowed","blocked":"The request is blocked for your organization","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","request.invalidates.job.results":"The request invalidates the job results for this journey id version.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client 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":"Some content of body contains 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":{"entity.not.found":"The journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":{"external.query.failure":"The request to external 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":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:edit"]},"x-purecloud-method-name":"putJourneyViewVersion"}},"/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":{"limit.exceeded":"Body content has exceeded the authorized limit","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","malformed.value":"Some content of body contains malformed value","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","not.allowed":"Some content of body is not allowed","blocked":"The request is blocked for your organization","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client 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":"Some content of body contains 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":{"entity.not.found":"The journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":{"external.query.failure":"The request to external 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":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:edit"]},"x-purecloud-method-name":"postJourneyViewVersions"}},"/api/v2/journey/views":{"get":{"tags":["Journey"],"summary":"Get a list of Journey Views","description":"","operationId":"getJourneyViews","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":"nameOrCreatedBy","in":"query","description":"Journey View Name or Created By","required":false,"type":"string"},{"name":"expand","in":"query","description":"Parameter to request additional data to return in Journey payload","required":false,"type":"string","enum":["charts"]},{"name":"id","in":"query","description":"Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.","required":false,"type":"string"}],"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":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","limit.exceeded":"Query parameter has exceed the authorize 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]","response.too.large":"The payload of the response is too large","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViews"},"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":{"missing.required":"Some headers or the body of the request are missing","limit.exceeded":"Body content has exceeded the authorized limit","bad.request":"The request could not be understood by the server due to malformed syntax.","malformed.value":"Some content of body contains malformed value","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","not.allowed":"Some content of body is not allowed","blocked":"The request is blocked for your organization","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client 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":"Some content of body contains 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":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":{"external.query.failure":"The request to external 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":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:add"]},"x-purecloud-method-name":"postJourneyViews"}},"/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}":{"get":{"tags":["Journey"],"summary":"Get a Chart by ID","description":"returns the latest version","operationId":"getJourneyViewVersionChart","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"name":"journeyViewVersion","in":"path","description":"Journey View Version","required":true,"type":"string"},{"name":"chartId","in":"path","description":"chartId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewChart"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey or chart was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViewVersionChart"}},"/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}":{"get":{"tags":["Journey"],"summary":"Get a Chart by ID and version","description":"","operationId":"getJourneyViewVersionChartVersion","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"name":"journeyViewVersion","in":"path","description":"Journey View Version","required":true,"type":"string"},{"name":"chartId","in":"path","description":"chartId","required":true,"type":"string"},{"name":"chartVersion","in":"path","description":"chartVersion","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewChart"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey or chart was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViewVersionChartVersion"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"patch":{"tags":["Journey"],"summary":"Update the job for a journey view version. Only the status can be changed and only to Cancelled","description":"used for long descriptions","operationId":"patchJourneyViewVersionJob","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"},{"in":"body","name":"body","description":"journeyViewJob","required":true,"schema":{"$ref":"#/definitions/JourneyViewJob"}}],"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","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:edit"]},"x-purecloud-method-name":"patchJourneyViewVersionJob"}},"/api/v2/journey/views/jobs":{"get":{"tags":["Journey"],"summary":"Get the jobs for an organization.","description":"","operationId":"getJourneyViewsJobs","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"The number of the page to return","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max number of entities to return","required":false,"type":"integer","default":25,"format":"int32"},{"name":"interval","in":"query","description":"An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.","required":false,"type":"string","format":"interval","x-example":"2023-07-17T00:00:00Z/2023-07-18T00:00:00Z"},{"name":"statuses","in":"query","description":"Job statuses to filter for","required":false,"type":"string","x-example":"statuses=Accepted,Executing,Complete,Failed"}],"responses":{"200":{"description":"Request completed successfully","schema":{"$ref":"#/definitions/JourneyViewJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getJourneyViewsJobs"}},"/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}":{"get":{"tags":["Journey"],"summary":"Get the chart result associated with a journey view job.","description":"","operationId":"getJourneyViewVersionJobResultsChart","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"},{"name":"chartId","in":"path","description":"ChartId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewChartResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getJourneyViewVersionJobResultsChart"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/api/v2/journey/views/schedules":{"get":{"tags":["Journey"],"summary":"Get the journey schedules for an organization.","description":"","operationId":"getJourneyViewsSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"The number of the page to return","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max number of entities to return","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Request completed successfully","schema":{"$ref":"#/definitions/JourneyViewScheduleListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:view"]},"x-purecloud-method-name":"getJourneyViewsSchedules"}},"/api/v2/journey/views/{viewId}/schedules":{"get":{"tags":["Journey"],"summary":"Get the Schedule for a JourneyView","description":"used for long descriptions","operationId":"getJourneyViewSchedules","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:view"]},"x-purecloud-method-name":"getJourneyViewSchedules"},"post":{"tags":["Journey"],"summary":"Add a new Schedule to a JourneyView","description":"","operationId":"postJourneyViewSchedules","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"in":"body","name":"body","description":"journeyViewSchedule","required":true,"schema":{"$ref":"#/definitions/JourneyViewSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"201":{"description":"Schedule created successfully.","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:add"]},"x-purecloud-method-name":"postJourneyViewSchedules"},"put":{"tags":["Journey"],"summary":"Update the Schedule for a JourneyView","description":"used for long descriptions","operationId":"putJourneyViewSchedules","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"in":"body","name":"body","description":"journeyViewSchedule","required":true,"schema":{"$ref":"#/definitions/JourneyViewSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:edit"]},"x-purecloud-method-name":"putJourneyViewSchedules"},"delete":{"tags":["Journey"],"summary":"Delete the Schedule of a JourneyView","description":"used for long descriptions","operationId":"deleteJourneyViewSchedules","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"204":{"description":"Scheduling 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","custom.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":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:delete"]},"x-purecloud-method-name":"deleteJourneyViewSchedules"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/integrations/{integrationId}/options":{"get":{"tags":["Knowledge"],"summary":"Get sync options available for a knowledge-connect integration","description":"","operationId":"getKnowledgeIntegrationOptions","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"knowledgeBaseIds","in":"query","description":"Narrowing down filtering option results by knowledge base.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeIntegrationOptionsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","third.party.unknown.host":"Request to third party service failed: unknown host.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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.integration":"The provided integration is not active.","constraint.validation":"%s","third.party.invalid.credentials":"Request to third party service failed: invalid 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.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one 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 or Credential not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"third.party.unexpected.error":"Request to third party service failed: unexpected error.","internal.dependency.error":"Internal dependency 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","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationOptions:view"]},"x-purecloud-method-name":"getKnowledgeIntegrationOptions"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/sources":{"get":{"tags":["Knowledge"],"summary":"Get Knowledge integration sources","description":"","operationId":"getKnowledgeKnowledgebaseSources","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"type","in":"query","description":"If specified, retrieves integration sources with specified integration type.","required":false,"type":"string","enum":["Salesforce","ServiceNow"]},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["lastsync"]},"collectionFormat":"multi"},{"name":"ids","in":"query","description":"If specified, retrieves integration sources with specified IDs.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SourceBaseResponse"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseSources"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}":{"get":{"tags":["Knowledge"],"summary":"Get Salesforce Knowledge integration source","description":"","operationId":"getKnowledgeKnowledgebaseSourcesSalesforceSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source 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":["lastsync"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"Get Salesforce Knowledge integration source","schema":{"$ref":"#/definitions/SalesforceSourceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Salesforce source not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseSourcesSalesforceSourceId"},"put":{"tags":["Knowledge"],"summary":"Update Salesforce Knowledge integration source","description":"","operationId":"putKnowledgeKnowledgebaseSourcesSalesforceSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SalesforceSourceRequest"}}],"responses":{"200":{"description":"Salesforce Knowledge integration source updated","schema":{"$ref":"#/definitions/SalesforceSourceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source or Integration not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:edit"]},"x-purecloud-method-name":"putKnowledgeKnowledgebaseSourcesSalesforceSourceId"},"delete":{"tags":["Knowledge"],"summary":"Delete Salesforce Knowledge integration source","description":"","operationId":"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"}],"responses":{"204":{"description":"Salesforce Knowledge integration source 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":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync":{"post":{"tags":["Knowledge"],"summary":"Start sync on Salesforce Knowledge integration source","description":"","operationId":"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"Another synchronization is already running for this source","schema":{"$ref":"#/definitions/SourceSyncResponse"}},"202":{"description":"Synchronization on Salesforce Knowledge integration source started","schema":{"$ref":"#/definitions/SourceSyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Manual synchronization limit exceeded."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source or Integration not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce":{"post":{"tags":["Knowledge"],"summary":"Create Salesforce Knowledge integration source","description":"","operationId":"postKnowledgeKnowledgebaseSourcesSalesforce","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/SalesforceSourceRequest"}}],"responses":{"200":{"description":"Salesforce Knowledge integration source created","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Number of sources limit exceeded."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one 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 or KnowledgeBase not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSourcesSalesforce"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}":{"get":{"tags":["Knowledge"],"summary":"Get ServiceNow Knowledge integration source","description":"","operationId":"getKnowledgeKnowledgebaseSourcesServicenowSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source 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":["lastsync"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"Get ServiceNow Knowledge integration source","schema":{"$ref":"#/definitions/ServiceNowSourceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"ServiceNow source not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseSourcesServicenowSourceId"},"put":{"tags":["Knowledge"],"summary":"Update ServiceNow Knowledge integration source","description":"","operationId":"putKnowledgeKnowledgebaseSourcesServicenowSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ServiceNowSourceRequest"}}],"responses":{"200":{"description":"ServiceNow Knowledge integration source updated","schema":{"$ref":"#/definitions/ServiceNowSourceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source or Integration not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:edit"]},"x-purecloud-method-name":"putKnowledgeKnowledgebaseSourcesServicenowSourceId"},"delete":{"tags":["Knowledge"],"summary":"Delete ServiceNow Knowledge integration source","description":"","operationId":"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"}],"responses":{"204":{"description":"ServiceNow Knowledge integration source 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":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync":{"post":{"tags":["Knowledge"],"summary":"Start synchronization on ServiceNow Knowledge integration source","description":"","operationId":"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"Another sync is already running for this source","schema":{"$ref":"#/definitions/SourceSyncResponse"}},"202":{"description":"Synchronization on ServiceNow Knowledge integration source started","schema":{"$ref":"#/definitions/SourceSyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Manual synchronization limit exceeded."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source or Integration not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow":{"post":{"tags":["Knowledge"],"summary":"Create ServiceNow Knowledge integration source","description":"","operationId":"postKnowledgeKnowledgebaseSourcesServicenow","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/ServiceNowSourceRequest"}}],"responses":{"200":{"description":"ServiceNow Knowledge integration source created","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Number of sources limit exceeded."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one 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 or KnowledgeBase not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSourcesServicenow"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"Daily or monthly upload limit exceeded.","x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/answers":{"post":{"tags":["Knowledge"],"summary":"Answer documents.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsAnswers","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/KnowledgeDocumentsAnswerFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeAnswerDocumentsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","knowledge:documentAnswer:view"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsAnswers"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/KnowledgeDocumentCreateRequest"}}],"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"]},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["contentUrl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/DocumentVariationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationResponse"}},"400":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["contentUrl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/DocumentVariationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationResponse"}},"400":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"patch":{"tags":["Knowledge"],"summary":"Update feedback on a document","description":"","operationId":"patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId","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"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackUpdateRequest"}}],"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","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/documents/query":{"post":{"tags":["Knowledge"],"summary":"Query for knowledge documents.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsQuery","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/KnowledgeDocumentQuery"}},{"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","knowledgeBaseLanguageCode"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"postKnowledgeKnowledgebaseDocumentsQuery"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/synchronize/jobs/{syncJobId}":{"get":{"tags":["Knowledge"],"summary":"Get synchronization job report","description":"","operationId":"getKnowledgeKnowledgebaseSynchronizeJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"syncJobId","in":"path","description":"Synchronization job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Get synchronization job","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:syncJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseSynchronizeJob"},"delete":{"tags":["Knowledge"],"summary":"Delete synchronization job","description":"","operationId":"deleteKnowledgeKnowledgebaseSynchronizeJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"syncJobId","in":"path","description":"Synchronization job ID","required":true,"type":"string"}],"responses":{"204":{"description":"Synchronization 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:syncJob:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseSynchronizeJob"},"patch":{"tags":["Knowledge"],"summary":"Update synchronization job","description":"","operationId":"patchKnowledgeKnowledgebaseSynchronizeJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"syncJobId","in":"path","description":"Synchronization job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SyncStatusRequest"}}],"responses":{"202":{"description":"Synchronization job updated","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:syncJob:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseSynchronizeJob"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs":{"post":{"tags":["Knowledge"],"summary":"Create synchronization job","description":"","operationId":"postKnowledgeKnowledgebaseSynchronizeJobs","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/KnowledgeSyncJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"202":{"description":"Synchronization job in progress","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:syncJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSynchronizeJobs"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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","knowledgeBaseLanguageCode"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/namespaces/{namespaceName}/limits/{limitName}/counts":{"get":{"tags":["Organization"],"summary":"Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.","description":"See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).","operationId":"getOrganizationsLimitsNamespaceLimitCounts","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to get","required":true,"type":"string"},{"name":"limitName","in":"path","description":"The limit to get","required":true,"type":"string"},{"name":"entityId","in":"query","description":"entity id of the count","required":false,"type":"string"},{"name":"userId","in":"query","description":"userid of the count","required":false,"type":"string"},{"name":"cursor","in":"query","description":"Cursor provided when retrieving the last page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitCountListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:count:view"]},"x-purecloud-method-name":"getOrganizationsLimitsNamespaceLimitCounts"}},"/api/v2/organizations/limits/namespaces/{namespaceName}/counts":{"get":{"tags":["Organization"],"summary":"Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.","description":"See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).","operationId":"getOrganizationsLimitsNamespaceCounts","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to get","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor provided when retrieving the last page","required":false,"type":"string"},{"name":"entityId","in":"query","description":"entity id of the count","required":false,"type":"string"},{"name":"userId","in":"query","description":"userid of the count","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitCountListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:count:view"]},"x-purecloud-method-name":"getOrganizationsLimitsNamespaceCounts"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","supported.content.in.use.sms":"The supported content profile is in use by an SMS 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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","forbidden":"Forbidden from sending a journey app event.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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/journey/deployments/{deploymentId}/webevents":{"post":{"tags":["Journey"],"summary":"Send a journey web event, used for tracking customer activity on a website.","description":"","operationId":"postJourneyDeploymentWebevents","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the web event.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/WebEventRequest"}}],"responses":{"200":{"description":"Request completed successfully.","schema":{"$ref":"#/definitions/WebEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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 web 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":"postJourneyDeploymentWebevents"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/answers":{"post":{"tags":["Knowledge"],"summary":"Answer documents.","description":"","operationId":"postKnowledgeGuestSessionDocumentsAnswers","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentsAnswerFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestAnswerDocumentsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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":"postKnowledgeGuestSessionDocumentsAnswers"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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/{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","knowledgeBaseLanguageCode"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"chat.error.service.unavailable":"Chat service 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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 from 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":{"not.found":"The requested resource was not found.","wfm.external.calendar.entity.not.found":"The requested calendar 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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).","notification.unauthorized.divisioned.topic":"No divisioned permissions for this topic.","app.not.authorized.for.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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).","notification.unauthorized.divisioned.topic":"No divisioned permissions for this topic.","app.not.authorized.for.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":{"entity.not.found":"Subscription list not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/usage/events/query":{"post":{"tags":["Operational Events"],"summary":"Query operational events in a timeframe.","description":"","operationId":"postUsageEventsQuery","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/EventQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"usage.events.too.old":"The requested interval doesn't contain any events because it's too far in the past","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"postUsageEventsQuery"}},"/api/v2/usage/events/aggregates/query":{"post":{"tags":["Operational Events"],"summary":"Get aggregates for operational events in a timeframe.","description":"","operationId":"postUsageEventsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EventAggregatesQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventAggregatesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"usage.events.too.old":"The requested interval doesn't contain any events because it's too far in the past","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"postUsageEventsAggregatesQuery"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/trustees/care":{"get":{"tags":["Organization Authorization"],"summary":"Get Customer Care organization ids.","description":"","operationId":"getOrgauthorizationTrusteesCare","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrusteeReferenceList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getOrgauthorizationTrusteesCare"},"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":"postOrgauthorizationTrusteesCare","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"},{"name":"assignFullAccess","in":"query","description":"Grant Customer Care full access to the organization","required":false,"type":"boolean"},{"name":"allowTrustedUserAccess","in":"query","description":"Make Customer Care a Trusted User","required":false,"type":"boolean"}],"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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"postOrgauthorizationTrusteesCare"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","enum":["all","call","chat","callback","email","videoComm","message"]},{"name":"labelId","in":"query","description":"Unique id that represents the interaction label used with media type for EWT calculation","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 requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization 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: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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationconfiguration.invalidrestoretimemilliseconds":"Restore time value out of bounds","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"userState","in":"query","description":"'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. \n'Any' fetches users of 'active', 'inactive' and 'deleted' states.","required":false,"type":"string","default":"Legacy","enum":["Any","Legacy"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"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"},{"name":"includeDeletedUsers","in":"query","description":"Allow returning an agent or evaluator user with a 'delete' status. Defaults to false.","required":false,"type":"boolean","default":false}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"general.internal.server.error":"An internal server 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":["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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"general.internal.server.error":"An internal server 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":["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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"general.internal.server.error":"An internal server 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":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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-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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","recording:settings:editRegionalStorage","recording:settings:editUrlExpiration"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"This API is deprecated and the functionality to stop screen recording will be no longer supported.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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"]}],"deprecated":true,"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","composer.form.path.invalid.format":"Evaluation form path format 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","rms.field.exceeds.max.length":"Field exceeds max length","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization 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: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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"skillsservice.skillnotfound":"The Skill 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"skillsservice.skillnotfound":"The Skill 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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]","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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]","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","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 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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]","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.domain.not.found":"The domain could not be 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.domain.not.found":"The domain could not be 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Route create completed.","schema":{"$ref":"#/definitions/InboundRoute"}},"202":{"description":"Accepted - route creation in progress.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","whatsapp","open","instagram","apple"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/{phoneNumberId}":{"get":{"tags":["Routing"],"summary":"Get a phone number provisioned for SMS.","description":"","operationId":"getRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"phoneNumberId","in":"path","description":"phone number","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand response with additional information","required":false,"type":"string","enum":["compliance","supportedContent"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"phoneNumberId","in":"path","description":"phone number","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"phoneNumberId","in":"path","description":"phone number","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"},{"name":"supportedContent.id","in":"query","description":"Filter based on the supported content ID","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"division.authorization.timeout":"Division authorization 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/assistant":{"get":{"tags":["Routing"],"summary":"Get an assistant associated with a queue.","description":"","operationId":"getRoutingQueueAssistant","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["assistant"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:view"]},"x-purecloud-method-name":"getRoutingQueueAssistant"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/directroutingbackup/settings/me":{"get":{"tags":["Routing","Users"],"summary":"Get the user's Direct Routing Backup settings.","description":"","operationId":"getRoutingDirectroutingbackupSettingsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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's backup settings 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:selfView"]},"x-purecloud-method-name":"getRoutingDirectroutingbackupSettingsMe"},"put":{"tags":["Routing","Users"],"summary":"Update the user's Direct Routing Backup settings.","description":"","operationId":"putRoutingDirectroutingbackupSettingsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"directRoutingBackup","required":true,"schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:selfEdit"]},"x-purecloud-method-name":"putRoutingDirectroutingbackupSettingsMe"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.","description":"","operationId":"deleteRoutingDirectroutingbackupSettingsMe","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:selfDelete"]},"x-purecloud-method-name":"deleteRoutingDirectroutingbackupSettingsMe"}},"/api/v2/routing/users/{userId}/directroutingbackup/settings":{"get":{"tags":["Routing","Users"],"summary":"Get the user's Direct Routing Backup settings.","description":"","operationId":"getRoutingUserDirectroutingbackupSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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 user's backup settings 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:view"]},"x-purecloud-method-name":"getRoutingUserDirectroutingbackupSettings"},"put":{"tags":["Routing","Users"],"summary":"Update the user's Direct Routing Backup settings.","description":"","operationId":"putRoutingUserDirectroutingbackupSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"directRoutingBackup","required":true,"schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:edit"]},"x-purecloud-method-name":"putRoutingUserDirectroutingbackupSettings"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.","description":"","operationId":"deleteRoutingUserDirectroutingbackupSettings","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","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."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:delete"]},"x-purecloud-method-name":"deleteRoutingUserDirectroutingbackupSettings"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","resource.not.found":"A referenced resource, such as a division, was not 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":"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."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:enterprise:2.0:User:dateHire","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:enterprise:2.0:User:dateHire","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:enterprise:2.0:User:dateHire","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:enterprise:2.0:User:dateHire","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:enterprise:2.0:User:dateHire","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:enterprise:2.0:User:dateHire","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:enterprise:2.0:User:dateHire","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:enterprise:2.0:User:dateHire","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","transcription","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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","externalContactsSettings","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","transcription","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"200 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"publish.programs.unpublished.topic.links.limit.exceeded":"Publishing programs with more than 500 unpublished topics is not allowed. Please publish the topics separately and try again."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"202":{"description":"The program was updated successfully, the topic links are being processed","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","topics.per.dialect.per.program.limit.exceeded":"500 topics per dialect per program 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":{"202":{"description":"The program was deleted successfully, the topic links are being deleted","schema":{"$ref":"#/definitions/DeleteProgramResponse"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"202":{"description":"The program was created successfully, the topic links are being processed","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","topics.per.dialect.per.program.limit.exceeded":"500 topics per dialect per program 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"topics.per.dialect.per.program.limit.exceeded":"500 topics per dialect per program quota exceeded","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"}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"linked.programs.limit.exceeded":"10 linked programs limit exceeded. Try linking the topic using program update api."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"topics.per.dialect.per.program.limit.exceeded":"500 topics per dialect per program quota exceeded","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.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":{"linked.programs.limit.exceeded":"10 linked programs limit exceeded. Try linking the topic using program update api."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.supported.above.500.topics":"Unpublished programs is not supported 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"expand","in":"query","description":"Expand the division name","required":false,"type":"string","enum":["entities.division"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/alertablepresences":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no overrides, it is the default list.","description":"","operationId":"getTelephonyProvidersEdgesAlertablepresences","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["defaults","overrides"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlertablePresences"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"alertablepresencesoverrides.duplicatesnotallowed":"The same value may not be specified more than once.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"A value was specified for the 'type' query parameter that did not equal 'defaults' or 'overrides'","invalid.property":"Value [%s] is not a valid property for object [%s]","alertablepresencesoverrides.invalidalertablepresence":"The specified presences are not valid system presences.","alertablepresencesoverrides.availablepresencenotspecified":"Overrides must include the 'Available' system presence.","constraint.validation":"%s","invalid.value":"Presence value was specified that does not exist in the OrganizationPresenceDefinition.SystemPresence enum."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:alertablePresences:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesAlertablepresences"},"put":{"tags":["Telephony Providers Edge"],"summary":"Creates or updates alertable presences overrides.","description":"","operationId":"putTelephonyProvidersEdgesAlertablepresences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Alertable Presences Overrides","required":true,"schema":{"$ref":"#/definitions/AlertablePresences"}}],"responses":{"202":{"description":"Accepted - processing create/update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"alertablepresencesoverrides.duplicatesnotallowed":"The same value may not be specified more than once.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","alertablepresencesoverrides.invalidalertablepresence":"The specified presences are not valid system presences.","alertablepresencesoverrides.availablepresencenotspecified":"Overrides must include the 'Available' system presence.","constraint.validation":"%s","invalid.value":"Presence value was specified that does not exist in the OrganizationPresenceDefinition.SystemPresence enum."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:alertablePresences:edit"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesAlertablepresences"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Deletes alertable presences overrides.","description":"","operationId":"deleteTelephonyProvidersEdgesAlertablepresences","produces":["application/json"],"parameters":[],"responses":{"202":{"description":"Accepted - processing deletion"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:alertablePresences:delete"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesAlertablepresences"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["id","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/search":{"get":{"tags":["Telephony Providers Edge","Search"],"summary":"Search sites using the q64 value returned from a previous search","description":"","operationId":"getTelephonyProvidersEdgesSitesSearch","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/SitesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getTelephonyProvidersEdgesSitesSearch"},"post":{"tags":["Telephony Providers Edge","Search"],"summary":"Search sites","description":"","operationId":"postTelephonyProvidersEdgesSitesSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SiteSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SitesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"Sites not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSitesSearch"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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","GenesysDigitalBotFlow","GenesysVoiceSurveyFlow"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","organization","organization:readonly"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]}],"deprecated":true,"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{recordingId}/transcoding":{"get":{"tags":["User Recordings"],"summary":"Download a user recording.","description":"","operationId":"getUserrecordingTranscoding","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"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-inin-requires-permissions":{"type":"ANY","permissions":["They are enforced by the backend"]},"x-purecloud-method-name":"getUserrecordingTranscoding"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/chats/me":{"get":{"tags":["Users"],"summary":"Get chats for a user","description":"","operationId":"getUsersChatsMe","produces":["application/json"],"parameters":[{"name":"excludeClosed","in":"query","description":"Whether or not to exclude closed chats","required":false,"type":"boolean"},{"name":"includePresence","in":"query","description":"Whether or not to include user presence","required":false,"type":"boolean"},{"name":"after","in":"query","description":"The key to start after","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatItemCursorListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","user:chats:view"]},"x-purecloud-method-name":"getUsersChatsMe"}},"/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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","autoanswersettings"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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"},"x-inin-error-codes":{"user.not.found.on.delete":"User not found on 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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["admin","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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":["admin","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["admin","directory:organization:admin","directory:userPassword:edit"]},"x-purecloud-method-name":"postUserInvite"}},"/api/v2/users/{userId}/routinglanguages/{languageId}":{"delete":{"tags":["Users","Routing"],"summary":"Remove a routing language from a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 an assigned routing language's proficiency","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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 languages assigned to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign a routing language to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign multiple routing languages to a user. Max 50 routing languages in request body","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 an assigned routing skill's proficiency","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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 a routing skill from a 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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 assigned to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign a routing skill to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign multiple routing skills to a user, replacing any current assignments","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign multiple routing skills to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"general.internal.server.error":"An internal server 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":{"division.authorization.timeout":"Division authorization timed out.","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 delete station association 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.","userservice.station.notfound":"The Station 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","userservice.station.providerlocationmissing":"The edge 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 to an edge"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/users/{userId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailUserMessages","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/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":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:voicemail:viewOther"]},"x-purecloud-method-name":"getVoicemailUserMessages"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"502":{"description":"Bad Gateway","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.error":"External service 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":["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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/users/{userId}/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get a user's mailbox information","description":"","operationId":"getVoicemailUserMailbox","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","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":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:mailbox:viewOther"]},"x-purecloud-method-name":"getVoicemailUserMailbox"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","transcription"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","transcription"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","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","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"archy.state.invalid.job.id":"Invalid job ID supplied.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. 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","archy.state.wrong.endpoint":"Only Publish jobs are accessible via this endpoint.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","DECISIONTABLE","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","WORKTYPE"]},{"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","DECISIONTABLE","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","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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","DECISIONTABLE","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","WORKTYPE"]},{"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","DECISIONTABLE","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","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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","DECISIONTABLE","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","WORKTYPE"]},"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","DECISIONTABLE","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","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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","DECISIONTABLE","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","WORKTYPE"]},{"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","DECISIONTABLE","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","WORKTYPE"]},"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","DECISIONTABLE","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","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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","DECISIONTABLE","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","WORKTYPE"]},"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","DECISIONTABLE","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","WORKTYPE"]},"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","DECISIONTABLE","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","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.already.exists":"A flow outcome with the specified name already exists.","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","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.","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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":"Get 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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.voice.flow.invalid.operation":"Cannot perform requested operation on a voice 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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.","architect.worktype.invalid.id":"The worktype ID is invalid.","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.","architect.org.invalid.id":"The org ID 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.","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.","architect.worktype.not.found":"Could not find the worktype."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","architect.flow.cannot.create.worktype.used.in.existing.flow":"Flow cannot be created because another Workitem flow already references the same Worktype. You may only have one Workitem flow per Worktype.","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":{"architect.worktype.fetch.failed":"Failed to fetch the worktype.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.flow.associate.worktype.failed":"Failed to associate flow with the worktype."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.flow.dissociate.worktype.failed":"Failed to dissociate flow with the worktype.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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).","architect.org.disabled.for.request":"Unable to get system prompt resource due to organization being disabled.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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","DECISIONTABLE","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","WORKTYPE"]},"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","DECISIONTABLE","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","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"Filter by published status.","required":false,"type":"boolean"}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","flowDetails"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}":{"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.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 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. Informational, AssessedContent and Assessment are deprecated","required":true,"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment","External","Native"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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/employeeengagement/celebrations/{celebrationId}":{"delete":{"tags":["Employee Engagement"],"summary":"Deletes a celebration","description":"","operationId":"deleteEmployeeengagementCelebration","produces":["application/json"],"parameters":[{"name":"celebrationId","in":"path","description":"The ID of the celebration","required":true,"type":"string"}],"responses":{"204":{"description":"Celebration 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:celebration:delete"]},"x-purecloud-method-name":"deleteEmployeeengagementCelebration"},"patch":{"tags":["Employee Engagement"],"summary":"Set a state for a celebration","description":"","operationId":"patchEmployeeengagementCelebration","produces":["application/json"],"parameters":[{"name":"celebrationId","in":"path","description":"The ID of the celebration","required":true,"type":"string"},{"in":"body","name":"body","description":"Patch Celebration state","required":true,"schema":{"$ref":"#/definitions/CelebrationStateParam"}}],"responses":{"204":{"description":"Celebration State 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:celebration:edit"]},"x-purecloud-method-name":"patchEmployeeengagementCelebration"}},"/api/v2/employeeengagement/celebrations":{"get":{"tags":["Employee Engagement"],"summary":"Get all celebrations","description":"","operationId":"getEmployeeengagementCelebrations","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetCelebrationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement","employee-engagement:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:celebration:view"]},"x-purecloud-method-name":"getEmployeeengagementCelebrations"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"Assignment created","schema":{"$ref":"#/definitions/LearningAssignment"}},"202":{"description":"Assignment creation request accepted","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"Assignment rescheduled","schema":{"$ref":"#/definitions/LearningAssignment"}},"202":{"description":"Assignment reschedule request accepted","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"}},"202":{"description":"Assignment reassign request accepted","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"defaultShareableContentObject","in":"query","description":"The default SCO to retrieve","required":false,"type":"string","enum":["First","Last","Next"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/{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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/employeeengagement/recognitions/{recognitionId}":{"get":{"tags":["Employee Engagement"],"summary":"Gets a single recognition","description":"","operationId":"getEmployeeengagementRecognition","produces":["application/json"],"parameters":[{"name":"recognitionId","in":"path","description":"The Recognition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recognition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","receiver.caller.mismatch":"Permission denied, caller does not match the recipient","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement","employee-engagement:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:recognition:view"]},"x-purecloud-method-name":"getEmployeeengagementRecognition"}},"/api/v2/employeeengagement/recognitions":{"post":{"tags":["Employee Engagement"],"summary":"Creates a recognition","description":"","operationId":"postEmployeeengagementRecognitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create Recognition","required":true,"schema":{"$ref":"#/definitions/CreateRecognition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecognitionBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:recognition:add"]},"x-purecloud-method-name":"postEmployeeengagementRecognitions"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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","settings.notifications.scheduling","settings.learning","settings.coaching"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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","LongTermStaffing","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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","LongTermStaffing","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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","LongTermStaffing","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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}/agents/workplans/query":{"post":{"tags":["Workforce Management"],"summary":"Get agents work plans configuration","description":"","operationId":"postWorkforcemanagementManagementunitAgentsWorkplansQuery","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/GetAgentsWorkPlansRequest"}},{"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":"Success","schema":{"$ref":"#/definitions/AgentsWorkPlansResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlan:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitAgentsWorkplansQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk":{"patch":{"tags":["Workforce Management"],"summary":"Updates agent work plan configuration","description":"","operationId":"patchWorkforcemanagementManagementunitAgentsWorkplansBulk","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/UpdateMuAgentWorkPlansBatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateMuAgentWorkPlansBatchResponse"}},"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/work plans not found in 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","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"patchWorkforcemanagementManagementunitAgentsWorkplansBulk"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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.","wfm.ids.may.not.be.blank":"One or more language, skill or queue 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","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The 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.too.many.skills.in.planning.group":"Too many skill IDs were passed across all route paths","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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.","wfm.ids.may.not.be.blank":"One or more language, skill or queue 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","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The 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.too.many.skills.in.planning.group":"Too many skill IDs were passed across all route paths","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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 week date of the initiating shift 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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 week date of the initiating shift 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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 week date of the initiating shift 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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 week date of the initiating shift 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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 week date of the initiating shift 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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 week date of the initiating shift 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/businessunits/{businessUnitId}/activityplans/jobs":{"get":{"tags":["Workforce Management"],"summary":"Gets the latest job for all activity plans in the business unit","description":"","operationId":"getWorkforcemanagementBusinessunitActivityplansJobs","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/ActivityPlanJobListing"}},"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":"Validation rules were violated on this 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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:activityPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivityplansJobs"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans":{"get":{"tags":["Workforce Management"],"summary":"Get activity plans","description":"","operationId":"getWorkforcemanagementBusinessunitActivityplans","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"state","in":"query","description":"Optionally filter by activity plan state","required":false,"type":"string","enum":["Active","Inactive"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanListing"}},"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":"Validation rules were violated on this 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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:activityPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivityplans"},"post":{"tags":["Workforce Management"],"summary":"Create an activity plan","description":"","operationId":"postWorkforcemanagementBusinessunitActivityplans","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":true,"schema":{"$ref":"#/definitions/CreateActivityPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanResponse"}},"201":{"description":"The activity plan was created successfully","schema":{"$ref":"#/definitions/ActivityPlanResponse"}},"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":"Validation rules were violated on this 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","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:activityPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitActivityplans"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Get an activity plan","description":"","operationId":"getWorkforcemanagementBusinessunitActivityplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"activityPlanId","in":"path","description":"The ID of the activity plan to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanResponse"}},"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":"Validation rules were violated on this 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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:activityPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivityplan"},"patch":{"tags":["Workforce Management"],"summary":"Update an activity plan","description":"If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated","operationId":"patchWorkforcemanagementBusinessunitActivityplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"activityPlanId","in":"path","description":"The ID of the activity plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/UpdateActivityPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanResponse"}},"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":"Validation rules were violated on this 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","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:activityPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitActivityplan"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs":{"post":{"tags":["Workforce Management"],"summary":"Run an activity plan manually","description":"Triggers a job running the activity plan. The activity plan cannot be updated until the job completes","operationId":"postWorkforcemanagementBusinessunitActivityplanRunsJobs","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"activityPlanId","in":"path","description":"The ID of the activity plan to run","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanJobResponse"}},"201":{"description":"The run activity plan job is running","schema":{"$ref":"#/definitions/ActivityPlanRunJobResponse"}},"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":"Validation rules were violated on this 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","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:activityPlanRunJob:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitActivityplanRunsJobs"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Gets an activity plan run job","description":"","operationId":"getWorkforcemanagementBusinessunitActivityplanRunsJob","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"activityPlanId","in":"path","description":"The ID of the activity plan associated with the run job","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The ID of the activity plan run job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanRunJobResponse"}},"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":"Validation rules were violated on this 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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:activityPlanRunJob:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivityplanRunsJob"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/businessunits/{businessUnitId}/alternativeshifts/settings":{"get":{"tags":["Workforce Management"],"summary":"Get alternative shifts settings for a business unit","description":"","operationId":"getWorkforcemanagementBusinessunitAlternativeshiftsSettings","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/AlternativeShiftBuSettingsResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitAlternativeshiftsSettings"},"patch":{"tags":["Workforce Management"],"summary":"Update alternative shifts settings for a business unit","description":"","operationId":"patchWorkforcemanagementBusinessunitAlternativeshiftsSettings","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/UpdateAlternativeShiftBuSettingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftBuSettingsResponse"}},"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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:businessUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitAlternativeshiftsSettings"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search":{"post":{"tags":["Workforce Management"],"summary":"List alternative shifts trades for a given management unit or agent","description":"","operationId":"postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/SearchAlternativeShiftTradesRequest"}},{"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/BuListAlternativeShiftTradesResponse"}},"202":{"description":"The search trades request is processing","schema":{"$ref":"#/definitions/BuListAlternativeShiftTradesResponse"}},"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]","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","wfm.entity.not.found":"One of the requested resources in the request body 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:alternativeShift:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift search trade 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":"getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The ID of the job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:alternativeShift:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}":{"get":{"tags":["Workforce Management"],"summary":"Get an alternative shifts trade in a business unit for a given trade ID","description":"","operationId":"getWorkforcemanagementBusinessunitAlternativeshiftsTrade","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"tradeId","in":"path","description":"The ID of the alternative shift trade","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"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","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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:alternativeShift:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitAlternativeshiftsTrade"}},"/api/v2/workforcemanagement/alternativeshifts/offers/jobs":{"post":{"tags":["Workforce Management"],"summary":"Request a list of alternative shift offers for a given schedule","description":"","operationId":"postWorkforcemanagementAlternativeshiftsOffersJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AlternativeShiftOffersRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"202":{"description":"The list offers request is processing","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"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.management.unit.not.found":"The requesting agent is not in a business or 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAlternativeshiftsOffersJobs"}},"/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift offers 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":"getWorkforcemanagementAlternativeshiftsOffersJob","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/AlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsOffersJob"}},"/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs":{"post":{"tags":["Workforce Management"],"summary":"Request a search of alternative shift offers for a given shift","description":"","operationId":"postWorkforcemanagementAlternativeshiftsOffersSearchJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AlternativeShiftSearchOffersRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"202":{"description":"The search offers request is processing","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"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.management.unit.not.found":"The requesting agent is not in a business or 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAlternativeshiftsOffersSearchJobs"}},"/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift search offers 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":"getWorkforcemanagementAlternativeshiftsOffersSearchJob","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/AlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsOffersSearchJob"}},"/api/v2/workforcemanagement/alternativeshifts/trades":{"get":{"tags":["Workforce Management"],"summary":"Get a list of my alternative shifts trades","description":"","operationId":"getWorkforcemanagementAlternativeshiftsTrades","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"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ListAlternativeShiftTradesResponse"}},"202":{"description":"The list trades request is processing","schema":{"$ref":"#/definitions/ListAlternativeShiftTradesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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 requesting agent is not in a business or 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsTrades"},"post":{"tags":["Workforce Management"],"summary":"Create my alternative shift trade using an existing offer's jobId","description":"","operationId":"postWorkforcemanagementAlternativeshiftsTrades","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/CreateAlternativeShiftTradeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"201":{"description":"The requested trade was created","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"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.entity.not.found":"The requesting agent is not in a business or 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAlternativeshiftsTrades"}},"/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift trades 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":"getWorkforcemanagementAlternativeshiftsTradesJob","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/AlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsTradesJob"}},"/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}":{"get":{"tags":["Workforce Management"],"summary":"Get my alternative shift trade by trade ID","description":"","operationId":"getWorkforcemanagementAlternativeshiftsTrade","produces":["application/json"],"parameters":[{"name":"tradeId","in":"path","description":"The ID of the alternative shift trade","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsTrade"},"patch":{"tags":["Workforce Management"],"summary":"Update my alternative shifts trade by trade ID","description":"","operationId":"patchWorkforcemanagementAlternativeshiftsTrade","produces":["application/json"],"parameters":[{"name":"tradeId","in":"path","description":"The ID of the alternative shift trade","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AgentUpdateAlternativeShiftTradeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"patchWorkforcemanagementAlternativeshiftsTrade"}},"/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs":{"patch":{"tags":["Workforce Management"],"summary":"Bulk update alternative shift trade states","description":"","operationId":"patchWorkforcemanagementAlternativeshiftsTradesStateJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AdminBulkUpdateAlternativeShiftTradeStateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"202":{"description":"The bulk update trade state request is processing","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:alternativeShift:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementAlternativeshiftsTradesStateJobs"}},"/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift trade state 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":"getWorkforcemanagementAlternativeshiftsTradesStateJob","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/AlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:alternativeShift:edit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsTradesStateJob"}},"/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":{"not.found":"The requested resource was not found.","wfm.external.calendar.entity.not.found":"The requested calendar 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/workplanbids":{"get":{"tags":["Workforce Management"],"summary":"Gets the list of work plan bids that belong to an agent","description":"","operationId":"getWorkforcemanagementWorkplanbids","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentWorkPlanBids"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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":"Agent work plan preference not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentWorkPlanBid:submit"]},"x-purecloud-method-name":"getWorkforcemanagementWorkplanbids"}},"/api/v2/workforcemanagement/workplanbids/{bidId}/preferences":{"get":{"tags":["Workforce Management"],"summary":"Gets an agent's work plan bidding preference","description":"","operationId":"getWorkforcemanagementWorkplanbidPreferences","produces":["application/json"],"parameters":[{"name":"bidId","in":"path","description":"The ID of the work plan bid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentWorkPlanBiddingPreferenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentWorkPlanBid:submit"]},"x-purecloud-method-name":"getWorkforcemanagementWorkplanbidPreferences"},"patch":{"tags":["Workforce Management"],"summary":"Update an agent's work plan bidding preference","description":"","operationId":"patchWorkforcemanagementWorkplanbidPreferences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateAgentWorkPlanBiddingPreference"}},{"name":"bidId","in":"path","description":"The ID of the work plan bid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentWorkPlanBiddingPreferenceResponse"}},"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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentWorkPlanBid:submit"]},"x-purecloud-method-name":"patchWorkforcemanagementWorkplanbidPreferences"}},"/api/v2/workforcemanagement/workplanbids/{bidId}/workplans":{"get":{"tags":["Workforce Management"],"summary":"Gets an agent's work plans for a bid","description":"","operationId":"getWorkforcemanagementWorkplanbidWorkplans","produces":["application/json"],"parameters":[{"name":"bidId","in":"path","description":"The ID of the work plan bid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentWorkPlanListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentWorkPlanBid:submit"]},"x-purecloud-method-name":"getWorkforcemanagementWorkplanbidWorkplans"}},"/api/v2/workforcemanagement/alternativeshifts/settings":{"get":{"tags":["Workforce Management"],"summary":"Get alternative shifts settings from the current logged in agent’s business unit","description":"","operationId":"getWorkforcemanagementAlternativeshiftsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftBuSettingsResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsSettings"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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"}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/workplanbids/{bidId}/groups/summary":{"get":{"tags":["Workforce Management"],"summary":"Get summary of bid groups that belong to a work plan bid","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidGroupSummaryList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups":{"post":{"tags":["Workforce Management"],"summary":"Add a bid group in a given work plan bid","description":"","operationId":"postWorkforcemanagementBusinessunitWorkplanbidGroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanBidGroupCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidGroupResponse"}},"201":{"description":"The work plan bid group was successfully created","schema":{"$ref":"#/definitions/WorkPlanBidGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWorkplanbidGroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}":{"get":{"tags":["Workforce Management"],"summary":"Get a bid group by bid group Id","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbidGroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"Work Plan Bid Group id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbidGroup"},"delete":{"tags":["Workforce Management"],"summary":"Delete a bid group by bid group Id","description":"","operationId":"deleteWorkforcemanagementBusinessunitWorkplanbidGroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"Work Plan Bid Group id","required":true,"type":"string"}],"responses":{"204":{"description":"The bid 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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWorkplanbidGroup"},"patch":{"tags":["Workforce Management"],"summary":"Update a bid group by bid group Id","description":"","operationId":"patchWorkforcemanagementBusinessunitWorkplanbidGroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"Work Plan Bid Group id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanBidGroupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitWorkplanbidGroup"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences":{"get":{"tags":["Workforce Management"],"summary":"Gets the work plan preferences of all the agents in the work plan bid group","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"The ID of the work plan bid group","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdminAgentWorkPlanPreferenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences"},"patch":{"tags":["Workforce Management"],"summary":"Overrides the assigned work plan for the specified agents","description":"","operationId":"patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"The ID of the work plan bid group","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AgentsBidAssignedWorkPlanOverrideRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdminAgentWorkPlanPreferenceResponse"}},"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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:workPlanBidGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences"}},"/api/v2/workforcemanagement/users/workplanbidranks/bulk":{"patch":{"tags":["Workforce Management"],"summary":"Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.","description":"","operationId":"patchWorkforcemanagementUsersWorkplanbidranksBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Users","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WorkPlanBidRanks"}}}],"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","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 of the requested resources in the request body 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementUsersWorkplanbidranksBulk"}},"/api/v2/workforcemanagement/users/{userId}/workplanbidranks":{"get":{"tags":["Workforce Management"],"summary":"Get work plan bid ranks for a user","description":"","operationId":"getWorkforcemanagementUserWorkplanbidranks","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The userId to whom the work plan bid ranks apply.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidRanks"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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:workPlanBid:view"]},"x-purecloud-method-name":"getWorkforcemanagementUserWorkplanbidranks"},"patch":{"tags":["Workforce Management"],"summary":"Update work plan bid ranks for a user","description":"","operationId":"patchWorkforcemanagementUserWorkplanbidranks","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The userId to whom the work plan bid ranks apply.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanBidRanks"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidRanks"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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:workPlanBid:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementUserWorkplanbidranks"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan bid","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbid","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The id of the workplanbid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBid"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbid"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan bid","description":"","operationId":"deleteWorkforcemanagementBusinessunitWorkplanbid","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The ID of the work plan bid","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan bid 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWorkplanbid"},"patch":{"tags":["Workforce Management"],"summary":"Update work plan bid","description":"","operationId":"patchWorkforcemanagementBusinessunitWorkplanbid","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The id of the workplanbid","required":true,"type":"string"},{"in":"body","name":"body","description":"The work plan bid to be updated","required":true,"schema":{"$ref":"#/definitions/UpdateWorkPlanBid"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBid"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitWorkplanbid"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids":{"get":{"tags":["Workforce Management"],"summary":"Get list of work plan bids","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbids","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/WorkPlanBidListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbids"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan bid","description":"","operationId":"postWorkforcemanagementBusinessunitWorkplanbids","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"The work plan bid to be created","required":false,"schema":{"$ref":"#/definitions/CreateWorkPlanBid"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBid"}},"201":{"description":"The work plan bid was successfully created","schema":{"$ref":"#/definitions/WorkPlanBid"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWorkplanbids"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a work plan bid","description":"","operationId":"postWorkforcemanagementBusinessunitWorkplanbidCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The ID of the work plan bid to copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlanBid"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBid"}},"201":{"description":"The work plan bid was successfully created","schema":{"$ref":"#/definitions/WorkPlanBid"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWorkplanbidCopy"}},"/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.query.operator.and.type":"Certain operators and types cannot be used together","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.query.null.with.operator.and.type":"Null values cannot be used with certain operators and types","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.entity.used":"Workbin still being used by a Worktype.","request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"Workbin","required":true,"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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]","query.filters.validation":"Query filters validation error","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","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","request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.cannot.remove.only.wrapup":"A users last wrap-up code cannot be removed.","request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.cannot.remove.only.wrapup":"A users last wrap-up code cannot be removed.","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","pre.check.worktype.has.flow":"Cannot delete a status when its worktype is linked to a workitem flow.","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.","pre.check.status.referenced.by.rule":"The status is being referenced by a rule."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Status","required":true,"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.auto.transition.disabled.for.terminate.status":"A status that terminates cannot add an auto transition.","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.default.status.cannot.be.terminating":"The initial status of a workitem cannot be configured as terminating status.","invalid.input.destinations.without.default.destination":"Destinations list does not contain the default destination.","invalid.input.auto.terminate.not.applicable.for.status.category":"Auto termination is not applicable for this status category.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Status","required":true,"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.auto.transition.disabled.for.terminate.status":"A status that terminates cannot add an auto transition.","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.auto.terminate.not.applicable.for.status.category":"Auto termination is not applicable for this status category.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.query.operator.and.type":"Certain operators and types cannot be used together","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.query.null.with.operator.and.type":"Null values cannot be used with certain operators and types","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","flow"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"Worktype","required":true,"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.default.status.cannot.be.terminating":"The initial status of a workitem cannot be configured as terminating status.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","pre.check.cannot.launch.flow.and.start.assignment":"A Worktype cannot be configured to launch both a flow and start assignment at workitem creation 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":["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":"Worktype","required":true,"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}":{"get":{"tags":["Task Management"],"summary":"Get an attribute change rule","description":"","operationId":"getTaskmanagementWorktypeFlowsOnattributechangeRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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 rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeFlowsOnattributechangeRule"},"delete":{"tags":["Task Management"],"summary":"Delete a rule","description":"","operationId":"deleteTaskmanagementWorktypeFlowsOnattributechangeRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","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","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 rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorktypeFlowsOnattributechangeRule"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a rule","description":"","operationId":"patchTaskmanagementWorktypeFlowsOnattributechangeRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"},{"in":"body","name":"body","description":"Rule","required":true,"schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRuleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"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","client.failed.request":"The client 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.no.change":"No changes found in request.","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 Rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","pre.check.name.in.use":"Name is already in use.","pre.check.conflicting.rule.condition":"Condition conflicts with another rules condition.","pre.check.cannot.have.equal.old.and.new.values":"Condition cannot having equal old and new values."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorktypeFlowsOnattributechangeRule"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules":{"get":{"tags":["Task Management"],"summary":"Get all attribute-change rules for a worktype","description":"","operationId":"getTaskmanagementWorktypeFlowsOnattributechangeRules","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"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRuleListing"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeFlowsOnattributechangeRules"},"post":{"tags":["Task Management"],"summary":"Add an attribute-change rule to a worktype","description":"","operationId":"postTaskmanagementWorktypeFlowsOnattributechangeRules","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"in":"body","name":"body","description":"Rule","required":true,"schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRuleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"201":{"description":"Workitem rule created.","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"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.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","pre.check.name.in.use":"Name is already in use.","pre.check.maximum.limit.reached":"The maximum amount of allowed attribute-change rules has been reached.","pre.check.conflicting.rule.condition":"Condition conflicts with another rules condition.","pre.check.cannot.have.equal.old.and.new.values":"Condition cannot having equal old and new values."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:add"]},"x-purecloud-method-name":"postTaskmanagementWorktypeFlowsOnattributechangeRules"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}":{"get":{"tags":["Task Management"],"summary":"Get an on-create rule","description":"","operationId":"getTaskmanagementWorktypeFlowsOncreateRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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 rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnCreate:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeFlowsOncreateRule"},"delete":{"tags":["Task Management"],"summary":"Delete a rule","description":"","operationId":"deleteTaskmanagementWorktypeFlowsOncreateRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","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","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 rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnCreate:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorktypeFlowsOncreateRule"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a rule","description":"","operationId":"patchTaskmanagementWorktypeFlowsOncreateRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"},{"in":"body","name":"body","description":"Rule","required":true,"schema":{"$ref":"#/definitions/WorkitemOnCreateRuleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"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","client.failed.request":"The client 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.no.change":"No changes found in request.","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 Rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:flowRuleOnCreate:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorktypeFlowsOncreateRule"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules":{"get":{"tags":["Task Management"],"summary":"Get all on-create rules for a worktype","description":"","operationId":"getTaskmanagementWorktypeFlowsOncreateRules","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"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnCreateRuleListing"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnCreate:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeFlowsOncreateRules"},"post":{"tags":["Task Management"],"summary":"Add an on-create rule to a worktype","description":"","operationId":"postTaskmanagementWorktypeFlowsOncreateRules","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"in":"body","name":"body","description":"Rule","required":true,"schema":{"$ref":"#/definitions/WorkitemOnCreateRuleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"201":{"description":"Workitem rule created.","schema":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","pre.check.name.in.use":"Name is already in use.","pre.check.maximum.limit.reached":"The maximum amount of allowed on-create rules has been reached for the worktype.","pre.check.cannot.launch.flow.and.start.assignment":"Worktype cannot have both assignmentEnabled set to true and an on-create launch flow rule."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnCreate:add"]},"x-purecloud-method-name":"postTaskmanagementWorktypeFlowsOncreateRules"}}},"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."}}},"EmailCommunicationSentMessageEvent":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"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."}}},"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}}},"Empty":{"type":"object"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"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}}},"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"}}},"OAuthAuthorizationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthAuthorization"}},"selfUri":{"type":"string","format":"uri"}}},"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}}},"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"},"inactivityTimeoutExclusions":{"type":"array","description":"The list of exempt apis from inactivity timeout.","items":{"type":"string"}}}},"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"}}},"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"}}},"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"}}},"AutoAnswerSetting":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The media type status."}}},"AutoAnswerSettings":{"type":"object","required":["settings"],"properties":{"settings":{"type":"object","description":"Map of conversation media type enabled status.","additionalProperties":{"$ref":"#/definitions/AutoAnswerSetting"}}}},"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"}}},"ExternalContactsSettings":{"type":"object","properties":{"manuallyAssignDivisionsToInteractions":{"type":"boolean"},"manuallyAssignDivisionsToContacts":{"type":"boolean"}}},"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/Image"}},"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"},"includeOwners":{"type":"boolean","description":"Allow owners to be included as members of the group"},"callsEnabled":{"type":"boolean","description":"Allow calls to be placed 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"]}}},"Image":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"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/Image"}},"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"},"workPlanBidRanks":{"description":"The WFM work plan bid rank settings for the user","readOnly":true,"$ref":"#/definitions/WorkPlanBidRanks"},"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"}}},"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 user."},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"AgentCopilotAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"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","hasAnswerHighlight","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","hasAnswerHighlight","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"}}},"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","botFlowSubType","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","previewMode","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","botFlowSubType","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","previewMode","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"}}},"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","originatingSocialMediaPublic","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","originatingSocialMediaPublic","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","oMessageCount","oMessageSegmentCount","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","oMessageCount","oMessageSegmentCount","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","internalmessage","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"]},"screenRecording":{"type":"boolean","description":"Flag determining if a screen recording was started or not"},"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","internalmessage","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","originatingSocialMediaPublic"],"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","oMessageCount","oMessageSegmentCount","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","screenRecording","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"]},"screenRecording":{"type":"boolean","description":"Flag determining if a screen recording was started or not"},"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","mediaType","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","mediaType","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"}}},"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"}}},"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"}}},"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"}}}},"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"]}}},"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","flowSubType","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","flowSubType","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","internalmessage","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"}}},"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","nWorkitemsOffered","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAgentFocusComplete","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","nWorkitemsOffered","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAgentFocusComplete","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"}}},"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"},"dateCompleted":{"type":"string","format":"date-time","description":"Timestamp indicating when the original turn was completed. Note: The 'interval' query param uses this timestamp to filter the output. 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","PartialCollection","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","SetWrapupCodeAction","TransferPureMatchAction","GetAttributesAction","SetAttributesAction","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"},"dateCompleted":{"type":"string","format":"date-time","description":"Timestamp indicating when the session was completed. Note: The 'interval' query param uses this timestamp to filter the output. 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","Open","Instagram","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","dateDeleted","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"},"dateDeleted":{"type":"string","format":"date-time","description":"The deleted 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"}}}},"SocialKeyword":{"type":"object","properties":{"includes":{"type":"array","description":"List of keywords that must be included","items":{"type":"string"}},"excludes":{"type":"array","description":"List of keywords that must be excluded","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","internalmessage","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","apple"]}},"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","Native"]}},"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"}},"dashboardType":{"type":"string","description":"The type of dashboard being filtered","enum":["All","Public","Private","Shared","Favorites","Deleted"]},"dashboardAccessFilter":{"type":"string","description":"The type of dashboard access being filtered","enum":["OwnedByMe","OwnedByAnyone","NotOwnedByMe"]},"transcriptDurationMilliseconds":{"type":"array","description":"The transcript durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"workitemsStatuses":{"type":"array","description":"The list of workitem status with worktype","items":{"$ref":"#/definitions/WorkitemStatusFilter"}},"socialCountries":{"type":"array","description":"List of countries for social filtering","items":{"type":"string"}},"socialLanguages":{"type":"array","description":"List of languages for social filtering","items":{"type":"string"}},"socialChannels":{"type":"array","description":"List of channels for social filtering","items":{"type":"string","enum":["Twitter","Facebook","Instagram","Open"]}},"socialSentimentCategory":{"type":"array","description":"The sentiment of the social post","items":{"type":"string","enum":["Positive","Negative","Neutral","Unknown"]}},"socialTopicIds":{"type":"array","description":"The list of topicIds for social filtering","items":{"type":"string"}},"socialIngestionRuleIds":{"type":"array","description":"The list of ingestion ruleIds for social filtering","items":{"type":"string"}},"socialConversationCreated":{"type":"boolean","description":"Filter to indicate if the post has created a conversation"},"socialContentType":{"type":"array","description":"The list of content Type for social filtering","items":{"type":"string","enum":["Text","Image","Video"]}},"socialKeywords":{"type":"array","description":"The list of keywords for social filtering","items":{"$ref":"#/definitions/SocialKeyword"}},"socialPostEscalated":{"type":"boolean","description":"Filter to indicate if the post is escalated"},"socialClassifications":{"type":"array","description":"Indicates if a social message was public or private","items":{"type":"string","enum":["Public","Private"]}},"filterUsersByManagerIds":{"type":"array","description":"The manager ids used to fetch associated users for the view","items":{"type":"string"}},"slideshowIds":{"type":"array","description":"List of Dashboard slideshowIds to be filtered","items":{"type":"string"}},"conferenced":{"type":"boolean","description":"Filter to indicate if the conversation has conference"}}},"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","internalmessage","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"]}},"agentInteractionSortOrder":{"type":"string","description":"The sort order of the interactions in the agent status widget.","enum":["ascending","descending"]}}},"WorkitemStatusFilter":{"type":"object","properties":{"worktypeId":{"type":"string","description":"Worktype ID belonging to the selected workitem status"},"workitemStatusId":{"type":"string","description":"Workitem status ID"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","SOCIAL_LISTENING_VIEW","SOCIAL_LISTENING_POSTS_VIEW","AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW","DASHBOARD_SLIDESHOWS","DASHBOARD_SLIDESHOWS_DETAIL","AGENT_COPILOT_PERFORMANCE_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","BAD_REQUEST_SCHEDULED_RUN"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","SOCIAL_LISTENING_VIEW","SOCIAL_LISTENING_POSTS_VIEW","AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW","DASHBOARD_SLIDESHOWS","DASHBOARD_SLIDESHOWS_DETAIL","AGENT_COPILOT_PERFORMANCE_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","SOCIAL_LISTENING_VIEW","SOCIAL_LISTENING_POSTS_VIEW","AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW","DASHBOARD_SLIDESHOWS","DASHBOARD_SLIDESHOWS_DETAIL","AGENT_COPILOT_PERFORMANCE_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"}}},"AnswerGenerationConfig":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Answer generation is enabled."}}},"Copilot":{"type":"object","required":["defaultLanguage","liveOnQueue"],"properties":{"enabled":{"type":"boolean","description":"Copilot is enabled.","readOnly":true},"liveOnQueue":{"type":"boolean","description":"Copilot is live on selected queue."},"defaultLanguage":{"type":"string","description":"Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified."},"knowledgeAnswerConfig":{"description":"Knowledge answer configuration.","$ref":"#/definitions/KnowledgeAnswerConfig"},"summaryGenerationConfig":{"description":"Copilot generated summary configuration.","$ref":"#/definitions/SummaryGenerationConfig"},"wrapupCodePredictionConfig":{"description":"Copilot generated wrapup code prediction configuration.","$ref":"#/definitions/WrapupCodePredictionConfig"},"answerGenerationConfig":{"description":"Answer generation configuration.","$ref":"#/definitions/AnswerGenerationConfig"},"nluEngineType":{"type":"string","description":"Language understanding engine type.","enum":["NluV3"]},"nluConfig":{"description":"NLU configuration.","$ref":"#/definitions/NluConfig"},"ruleEngineConfig":{"description":"Rule engine configuration.","$ref":"#/definitions/RuleEngineConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CopilotAction":{"type":"object","required":["actionType"],"properties":{"actionType":{"type":"string","description":"Type of action.","enum":["KnowledgeArticle","CannedResponse","Script"]},"attributes":{"type":"object","description":"Action specific attributes, if any. Maximum 100 of string key-value pair allowed.","additionalProperties":{"type":"string"}}}},"CopilotCondition":{"type":"object","required":["conditionType","conditionValues"],"properties":{"conditionType":{"type":"string","description":"Type of condition.","enum":["Intent","ConversationStart","ConversationTransfer","ConversationEnd"]},"conditionValues":{"type":"array","description":"Condition values.","items":{"type":"string"}}}},"CopilotFallbackAction":{"type":"object","required":["actionType"],"properties":{"actionType":{"type":"string","description":"Type of action.","enum":["KnowledgeArticle","CannedResponse","Script","KnowledgeSearch"]},"attributes":{"type":"object","description":"Action specific attributes, if any. Maximum 100 of string key-value pair allowed.","additionalProperties":{"type":"string"}}}},"CopilotNluDomain":{"type":"object","required":["id","useLatestVersion"],"properties":{"id":{"type":"string","description":"Id of the NLU domain."},"useLatestVersion":{"type":"boolean","description":"Use the latest version of the NLU domain. If false, version is required."},"version":{"description":"NLU domain version.","$ref":"#/definitions/CopilotNluDomainVersion"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CopilotNluDomainVersion":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the NLU v3 domain version."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CopilotRule":{"type":"object","required":["actions","conditions"],"properties":{"conditions":{"type":"array","description":"List of conditions to execute actions, must have at least 1 element and maximum 100 elements. Operator in case of multiple conditions: 'OR'.","items":{"$ref":"#/definitions/CopilotCondition"}},"actions":{"type":"array","description":"List of actions to execute, must have at least 1 element and maximum 100 elements.","items":{"$ref":"#/definitions/CopilotAction"}}}},"CopilotTranscriptionConfig":{"type":"object","required":["engine"],"properties":{"engine":{"type":"string","description":"The Transcription engine for Agent Copilot.","enum":["Genesys","GenesysExtended"]}}},"Fallback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Fallback actions are enabled."},"actions":{"type":"array","description":"Fallback actions.","items":{"$ref":"#/definitions/CopilotFallbackAction"}}}},"KnowledgeAnswerConfig":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Knowledge answer is enabled."}}},"NluConfig":{"type":"object","required":["domain","intentConfidenceThreshold"],"properties":{"domain":{"description":"NLU domain.","$ref":"#/definitions/CopilotNluDomain"},"intentConfidenceThreshold":{"type":"number","format":"float","description":"Minimum confidence value of accepting NLU intents, must be greater than 0 and less than 1."}}},"RuleConfig":{"type":"object","required":["enabled","rule"],"properties":{"id":{"type":"string","description":"Rule ID."},"enabled":{"type":"boolean","description":"Rule enabled."},"rule":{"description":"Rule configuration.","$ref":"#/definitions/CopilotRule"}}},"RuleEngineConfig":{"type":"object","required":["rules"],"properties":{"rules":{"type":"array","description":"List of rules to evaluate by the engine.","items":{"$ref":"#/definitions/RuleConfig"}},"fallback":{"description":"Fallback configuration.","$ref":"#/definitions/Fallback"}}},"SummaryGenerationConfig":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Copilot generated summary is enabled."}}},"WrapupCodePredictionConfig":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Copilot generated wrapup code prediction is enabled."}}},"ArticlesFilter":{"type":"object","properties":{"labels":{"description":"The labels filter.","$ref":"#/definitions/LabelsFilter"},"categories":{"description":"The categories filter.","$ref":"#/definitions/CategoriesFilter"}}},"Assistant":{"type":"object","required":["knowledgeSuggestionConfig","name","transcriptionConfig"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the assistant that will assist the agent."},"dateCreated":{"type":"string","format":"date-time","description":"Date when the assistant 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 when the assistant 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 assistant.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who last modified the assistant.","readOnly":true,"$ref":"#/definitions/UserReference"},"googleDialogflowConfig":{"description":"(Deprecated: use the 'knowledgeSuggestionConfig' for genesys knowledge suggestions) Configuration of Dialogflow used to assist the agent with transcriptions and knowledge suggestions.","$ref":"#/definitions/GoogleDialogflowConfig"},"transcriptionConfig":{"description":"Configuration for speech transcription used to assist the agent.","$ref":"#/definitions/TranscriptionConfig"},"knowledgeSuggestionConfig":{"description":"Configuration that defines how to produce knowledge suggestions.","$ref":"#/definitions/KnowledgeSuggestionConfig"},"state":{"type":"string","description":"State of the assistant.","readOnly":true,"enum":["Active","Inactive"]},"copilot":{"description":"Agent copilot configuration.","readOnly":true,"$ref":"#/definitions/Copilot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AssistantQueue":{"type":"object","required":["id","mediaTypes"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the queue."},"mediaTypes":{"type":"array","description":"List of media Types in which the assistant is activated for this queue.","items":{"type":"string","enum":["Call","Email","Message"]}},"assistant":{"description":"Assistant to which the queue is assigned.","readOnly":true,"$ref":"#/definitions/Assistant"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the assistant queue 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 when the assistant queue was last 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}}},"CategoriesFilter":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"A list of categories to filter by. Articles matching any of the specified categories can be accessed.","items":{"$ref":"#/definitions/CategoryEntity"}}}},"CategoryEntity":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Id of the category."},"selfUri":{"type":"string","format":"uri","description":"The selfUri of the category.","readOnly":true}}},"ConversationProfile":{"type":"object","required":["languageCode","name"],"properties":{"languageCode":{"type":"string","description":"The language code supported by the conversation profile belonging to a particular project for Dialogflow.","enum":["en","en-AU","en-CA","en-GB","en-IN","en-US"]},"name":{"type":"string","description":"The name of the conversation profile belonging to a particular project for Dialogflow"}}},"GoogleDialogflowConfig":{"type":"object","required":["conversationProfiles"],"properties":{"integrationId":{"type":"string","description":"The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions."},"conversationProfiles":{"type":"array","description":"The conversation profiles for which the assistant will fetch transcription and knowledge suggestions.","items":{"$ref":"#/definitions/ConversationProfile"}}}},"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}}},"KnowledgeBaseWithDialectReference":{"type":"object","required":["id","languageCode"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the knowledge base."},"languageCode":{"type":"string","description":"The dialect for the knowledge base.","enum":["en-ZA","en-AU","en-GB","en-IE","en-IN","en-US","es-US","es-ES","nl-NL","fr-CA","fr-FR","de-DE","it-IT","pt-PT","pt-BR","ar-AE","ja-JP","sv-SE","de-AT","de-CH","da-DK","fr-BE","fr-CH","es-MX","es-CO","es-AR"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSuggestionConfig":{"type":"object","required":["vendorName"],"properties":{"vendorName":{"type":"string","description":"The name of vendor used for knowledge suggestions.","enum":["GoogleDialogflow","GenesysKnowledge","Unknown"]},"knowledgeBase":{"description":"The ID of knowledge base to query when Genesys is the knowledge suggestions provider.","$ref":"#/definitions/KnowledgeBaseReference"},"knowledgeBases":{"type":"array","description":"The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider.","items":{"$ref":"#/definitions/KnowledgeBaseWithDialectReference"}}}},"LabelEntity":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Id of the label."},"selfUri":{"type":"string","format":"uri","description":"The selfUri of the label.","readOnly":true}}},"LabelsFilter":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"A list of labels to filter by. Articles matching any of the specified labels can be accessed.","items":{"$ref":"#/definitions/LabelEntity"}}}},"TranscriptionConfig":{"type":"object","required":["vendorName"],"properties":{"vendorName":{"type":"string","description":"The name of the vendor used for speech transcription.","enum":["GoogleDialogflow","Unknown","Genesys"]}}},"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}}},"AssistantQueueListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AssistantQueue"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"AssistantListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Assistant"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"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"}}}},"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"}}}},"AuditQueryExecutionLargeResultsResponse":{"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."},"downloadUrl":{"type":"string","description":"The presigned url which can be used to download the results."}}},"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"}}}},"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"}}}},"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"}}},"UserReferenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReference"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"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"}}},"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}}},"RoleSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"backfillEnabled":{"type":"boolean","description":"Boolean showing if organization is opted in or not to role backfills"},"authorizationGrantDivisionAware":{"type":"boolean","description":"Boolean enabling enforcement of division aware for authorization grant add and delete","allowEmptyValue":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: 60 min). Can only be used when ACW is AGENT_REQUESTED, 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"}},"mode":{"type":"string","description":"The mode callbacks will use on this queue.","enum":["AgentFirst","CustomerFirst"]},"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."},"pacingModifier":{"type":"number","format":"double","description":"Controls the maximum number of outbound calls at one time when mode is CustomerFirst."},"liveVoiceReactionType":{"type":"string","description":"The action to take if a live voice is detected during the outbound call of a customer first callback.","enum":["HangUp","TransferToQueue","TransferToFlow"]},"liveVoiceFlow":{"description":"The inbound flow to transfer to if a live voice is detected during the outbound call of a customer first callback.","$ref":"#/definitions/DomainEntityRef"},"answeringMachineReactionType":{"type":"string","description":"The action to take if an answering machine is detected during the outbound call of a customer first callback.","enum":["HangUp","TransferToQueue","TransferToFlow"]},"answeringMachineFlow":{"description":"The inbound flow to transfer to if an answering machine is detected during the outbound call of a customer first callback when answeringMachineReactionType is set to TransferToFlow.","$ref":"#/definitions/DomainEntityRef"}}},"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"}}},"EmailMediaSettings":{"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"}}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"]},"threshold":{"type":"number","format":"double"}}},"IdentityResolutionConfig":{"type":"object","required":["resolveIdentities"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"resolveIdentities":{"type":"boolean","description":"Whether the channel should resolve identities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityResolutionQueueConfig":{"type":"object","properties":{"callOnBehalfOfQueue":{"$ref":"#/definitions/IdentityResolutionConfig"}}},"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"},"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."},"cannedResponseLibraries":{"description":"Canned response library IDs and mode with which they are associated with the queue","$ref":"#/definitions/CannedResponseLibraries"},"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":{"description":"The default email address to use for outbound email from this queue.","$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/EmailMediaSettings"},"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"}}},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object"}}}},"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","business.rules","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gamification","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","internal.messaging","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"}}},"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, expressed as int in the range [10,3650]"}}},"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 if adhoc, the id of the group for group rooms","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"}},"jid":{"type":"string","description":"The jid of the room"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"AiScoringSetting":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True if AI Scoring feature is configured."}}},"AiScoringSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"questionGroupSettings":{"type":"array","items":{"$ref":"#/definitions/QuestionGroupSettings"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"evaluationSettings":{"description":"Settings for evaluations associated with this form","$ref":"#/definitions/EvaluationSettings"},"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":{"revisionsEnabled":{"type":"boolean","description":"Whether revisions are allowed for evaluations. When enabled, rescoring creates a new version of the evaluation and retracts the existing evaluation version. Does not apply for calibration evaluations."},"disputesEnabled":{"type":"boolean","description":"Whether disputes are allowed for evaluations. Does not apply for calibration evaluations."},"disputesAllowedPerEvaluation":{"type":"integer","format":"int32","description":"The maximum number of disputes allowed for an evaluation."},"disputesAssignees":{"type":"array","description":"A list of assignees responsible for handling each dispute. This list size needs to be equal to disputesAllowedPerEvaluation.","items":{"$ref":"#/definitions/EvaluationSettingsAssignee"}}}},"EvaluationSettingsAssignee":{"type":"object","properties":{"user":{"description":"The user the dispute should be assigned to","$ref":"#/definitions/UserReferenceWithName"},"type":{"type":"string","description":"The assignee type. Valid values: Original, Individual, None","enum":["Original","Individual","None"]}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"QuestionGroupSettings":{"type":"object","properties":{"questionGroupIndex":{"type":"integer","format":"int32","description":"This field represents the location of the Question Group in the form. Note: Indexes are zero-based"},"questionGroupContextId":{"type":"string","description":"The context id of the question group in the form."},"questionSettings":{"type":"array","items":{"$ref":"#/definitions/QuestionSettings"}}}},"QuestionSettings":{"type":"object","properties":{"questionIndex":{"type":"integer","format":"int32","description":"This field represents the location of the Question in the form. Note: Indexes are zero-based"},"questionContextId":{"type":"string","description":"The context id of the question in the group"},"settings":{"$ref":"#/definitions/AiScoringSetting"}}},"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"},"description":{"type":"string","description":"The wrap-up code description."},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","SocialInstagram","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":"Indicates the built-in entity type to which this schema applies.","readOnly":true,"items":{"type":"string","enum":["CONTACT","CONVERSATION","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"},"externalIds":{"type":"array","description":"A list of external identifiers that identify this contact in an external system","uniqueItems":true,"items":{"$ref":"#/definitions/ExternalId"}},"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"},"handle":{"type":"string","description":"The handle 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/Image"}},"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"},"workPlanBidRanks":{"description":"The WFM work plan bid rank settings for the user","readOnly":true,"$ref":"#/definitions/WorkPlanBidRanks"},"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"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","INTERNAL_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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"CursorExternalSourceListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalSource"}},"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","InternalMessage"]},"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."},"divisionIds":{"type":"array","description":"List of division IDs associated with the session.","items":{"type":"string"}},"lastScreen":{"type":"string","description":"The app screen name where the customer's last app interaction occurred."},"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"}}}},"CsvJobResponse":{"type":"object","required":["job"],"properties":{"job":{"description":"Job for the import","$ref":"#/definitions/AddressableEntityRef"}}},"CsvJobRequest":{"type":"object","required":["settingsId","uploadId"],"properties":{"uploadId":{"type":"string","description":"Upload for the csv job"},"settingsId":{"type":"string","description":"Settings for the csv job"}}},"CsvMappingEntry":{"type":"object","required":["sourceField","targetField"],"properties":{"sourceField":{"type":"string","description":"CSV field to map data from"},"targetField":{"type":"string","description":"Json path to map data to"}}},"CsvSettings":{"type":"object","required":["mappings"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"externalSettingsId":{"type":"string","description":"Id of the external settings"},"mappings":{"type":"array","description":"Mappings for the transformation","items":{"$ref":"#/definitions/CsvMappingEntry"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Listing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CsvSettings"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"CsvUploadDetailsResponse":{"type":"object","required":["uploadId","validationResult"],"properties":{"uploadId":{"type":"string","description":"Id for the upload"},"fileName":{"type":"string","description":"File name for the upload"},"validationResult":{"description":"Validation for the upload","$ref":"#/definitions/ValidationResult"}}},"ValidationError":{"type":"object","required":["lineNumber","message"],"properties":{"lineNumber":{"type":"integer","format":"int64","description":"Line number for the error in CSV"},"message":{"type":"string","description":"Detail of the error in CSV"}}},"ValidationResult":{"type":"object","required":["errors","fileEncodingValid","separatorValid"],"properties":{"separatorValid":{"type":"boolean","description":"Separator valid in the upload"},"fileEncodingValid":{"type":"boolean","description":"File encoding valid for the upload"},"errors":{"type":"array","description":"List of errors for the upload","items":{"$ref":"#/definitions/ValidationError"}}}},"CsvUploadPreviewResponse":{"type":"object","required":["entries","headers","uploadId"],"properties":{"uploadId":{"type":"string","description":"Id for the upload"},"headers":{"type":"array","description":"List of headers in the CSV","items":{"type":"string"}},"entries":{"type":"array","description":"List of entries in the CSV","items":{"type":"array","items":{"type":"string"}}}}},"CsvUploadResponse":{"type":"object","required":["uploadHeaders","uploadId","uploadUrl"],"properties":{"uploadId":{"type":"string","description":"Id of the upload"},"uploadUrl":{"type":"string","description":"Url for the upload"},"uploadHeaders":{"type":"array","description":"Required headers for the upload","items":{"$ref":"#/definitions/Header"}}}},"Header":{"type":"object","properties":{"name":{"type":"string","description":"Name of the header"},"value":{"type":"string","description":"Value of the header"}}},"CsvUploadRequest":{"type":"object","required":["fileSize"],"properties":{"fileName":{"type":"string","description":"Name of the file to upload","minLength":0,"maxLength":256},"fileSize":{"type":"integer","format":"int64","description":"The size of the upload file","maximum":52428800}}},"DocumentThumbnail":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"},"height":{"type":"integer","format":"int32"},"width":{"type":"integer","format":"int32"}}},"DownloadResponse":{"type":"object","properties":{"id":{"type":"string"},"contentLocationUri":{"type":"string"},"imageUri":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"state":{"type":"string","enum":["Running","Completed"]},"resultUri":{"type":"string"},"selfUri":{"type":"string"}}},"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"}}}},"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"}}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","LowHistoricalAccuracyError"]}}},"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/DivisionEntityRef"}}}},"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":["Reactions","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"}}},"DivisionEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"dateDivisionUpdated":{"type":"string","format":"date-time","description":"The time the entity division was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"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"},"parkTime":{"type":"string","format":"date-time","description":"Represents the time when an email was put into parked state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"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","INTERNAL_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."}}},"InternalMessage":{"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."},"segments":{"type":"array","description":"The time line of the participant's internal message, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["client","system","peer","transfer"]},"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."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"targetUserId":{"type":"string","description":"The user ID for the participant on receiving side of the internal message conversation."},"sourceUserId":{"type":"string","description":"The user ID for the participant on sending side of the internal message conversation."},"toAddress":{"description":"Address for the participant on receiving side of the internal message communication.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address for the participant on the sending side of the internal message communication.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"The messages sent on this communication channel.","items":{"$ref":"#/definitions/InternalMessageDetails"}}}},"InternalMessageDetails":{"type":"object","properties":{"messageId":{"type":"string","description":"UUID identifying the internal message media."},"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"}}},"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"},"socialVisibility":{"type":"string","description":"For social media messages, the visibility of the message in the originating social platform","enum":["private","public"]},"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."},"externalContactInitialDivisionId":{"type":"string","description":"If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned."},"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"},"internalMessages":{"type":"array","items":{"$ref":"#/definitions/InternalMessage"}},"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"}}},"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"}}},"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."}}},"ConversationUtilizationLabelUpdate":{"type":"object","properties":{"utilizationLabelId":{"type":"string","description":"The utilization label 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"]},"keepInternalMessageAlive":{"type":"boolean","description":"If true, the digital internal message will NOT be terminated."},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"agentOwnedColumn":{"type":"string","description":"Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns."},"dynamicContactQueueingSettings":{"description":"Settings for dynamic queueing of contacts.","$ref":"#/definitions/DynamicContactQueueingSettings"},"skillColumns":{"type":"array","description":"The skill columns on the ContactList that this Campaign should take into account when dialing","items":{"type":"string"}},"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"},"filter":{"type":"boolean","description":"Whether to filter 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"ParkingStateRequest":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"State to set the participant.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"ConversationContentReaction":{"type":"object","required":["count"],"properties":{"reactionType":{"type":"string","description":"Type of reaction.","enum":["None","Like","Love","Wow","Haha","Sad","Angry","Thankful","Pride","Care","Share","Comment","View"]},"count":{"type":"integer","format":"int32","description":"Number of users that reacted this way to the message."}},"description":"User reaction to public message."},"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."},"ConversationEnrichment":{"type":"object","properties":{"language":{"description":"Detected language of this message.","$ref":"#/definitions/ConversationEnrichmentLanguage"},"sentimentV2":{"description":"Detected sentiment of this message.","$ref":"#/definitions/ConversationEnrichmentSentimentV2"}},"description":"Metadata enrichments provided by the platform."},"ConversationEnrichmentLanguage":{"type":"object","required":["language"],"properties":{"language":{"type":"string","description":"The IETF detected language code of this message."}},"description":"Detected language of this message."},"ConversationEnrichmentSentimentV2":{"type":"object","required":["tag"],"properties":{"tag":{"type":"string","description":"Detected Sentiment tag","enum":["Unknown","Positive","Negative","Neutral"]}},"description":"Sentiment analysis of this message."},"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."}},"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":["Reactions","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","Apple","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},"externalContactId":{"type":"string","description":"The identifier of the external contact."},"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","Topic"]},"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},"externalContactId":{"type":"string","description":"The identifier of the external contact."},"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."},"ConversationNotificationTemplateButton":{"type":"object","required":["index","type"],"properties":{"type":{"type":"string","description":"Specifies the type of the button.","enum":["QuickReply","PhoneNumber","Url"]},"text":{"type":"string","description":"Button text message."},"index":{"type":"integer","format":"int64","description":"index of the button in the list."},"phoneNumber":{"type":"string","description":"Button phone number."},"url":{"type":"string","description":"Button URL link."},"parameters":{"type":"array","description":"Template parameters for placeholders in the button.","items":{"$ref":"#/definitions/ConversationNotificationTemplateParameter"}}},"description":"Template button 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."},"ConversationPublicMetadata":{"type":"object","properties":{"rootId":{"type":"string","description":"The id of the root public message."},"replyToId":{"type":"string","description":"The id of the message this public message is replying to."}},"description":"Information about a public message."},"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","Topic","IngestionRule","IngestionRuleVersion"]},"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","whatsapp","webmessaging","instagram","open","apple"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"}}},"TextMessageListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessageData"}}}},"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/SendMessagingTemplateRequest"}}},"SendMessagingTemplateRequest":{"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. (Deprecated) use bodyParameters instead.","items":{"$ref":"#/definitions/TemplateParameter"}},"headerParameters":{"type":"array","description":"A list of Response Management header parameter substitutions for the response's messaging template","items":{"$ref":"#/definitions/TemplateParameter"}},"bodyParameters":{"type":"array","description":"A list of Response Management body parameter substitutions for the response's messaging template","items":{"$ref":"#/definitions/TemplateParameter"}},"buttonUrlParameters":{"type":"array","description":"A list of Response Management button url parameter 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"}}},"CreateOutboundMessagingConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The created outbound messaging conversation ID.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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, unless useUserFromAddress is true and the queue is configured to use the agent's Direct Routing address as the fromAddress."},"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."},"useUserFromAddress":{"type":"boolean","description":"An override to attempt to use the user's configured direct routing address as the fromAddress. \nIf set to true, users configured address with 'directrouting' integration will be used as fromAddress. \nIf set to false or not set, the queueId will be used for determining fromAddress."}}},"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. (Deprecated - Instead use message.normalizedMessage.text)"},"messagingTemplate":{"description":"The messaging template sent. (Deprecated - Instead use message.normalizedMessage.content[#].template)","$ref":"#/definitions/SendMessagingTemplateRequest"},"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/SendMessagingTemplateRequest"},"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"}}},"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"},"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"}},"conversationId":{"type":"string","description":"The conversationId context for the message"}},"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","DatePicker","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","Failed"]},"messengerType":{"type":"string","description":"The type of Messaging Integration","readOnly":true,"enum":["sms","facebook","twitter","whatsapp","webmessaging","instagram","open","apple"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","whatsapp","webmessaging","instagram","open","apple"]},"timeoutInMinutes":{"type":"integer","format":"int64","description":"The conversation threading window timeout (Minutes) of specified messenger type"}}},"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"},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"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","InstagramPublic","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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"OpenMessagingIdentityResolutionConfig":{"type":"object","required":["resolveIdentities"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"resolveIdentities":{"type":"boolean","description":"Whether the channel should resolve identities"},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","Failed"]},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"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"]},"keepInternalMessageAlive":{"type":"boolean","description":"If true, the digital internal message will NOT be terminated."},"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"]},"keepInternalMessageAlive":{"type":"boolean","description":"If true, the digital internal message will NOT be terminated."},"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"]},"keepInternalMessageAlive":{"type":"boolean","description":"If true, the digital internal message will NOT be terminated."},"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"}}}},"Feedback":{"type":"object","required":["relevance","suggestionId"],"properties":{"suggestionId":{"type":"string","description":"Feedback suggestion id."},"userProvided":{"type":"boolean","description":"Indicates whether the answer/item was clicked by the human agent or not."},"relevance":{"type":"string","description":"Feedback relevance.","enum":["Unknown","Relevant","Irrelevant"]}}},"Article":{"type":"object","properties":{"title":{"type":"string","description":"The article title.","readOnly":true},"uri":{"type":"string","description":"The URI for the article.","readOnly":true},"snippets":{"type":"array","description":"This contains snippets of text from the article matching the query.","readOnly":true,"items":{"type":"string"}},"confidence":{"type":"number","format":"float","description":"Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all.","readOnly":true},"metadata":{"type":"object","description":"A map that contains custom metadata about the article answer.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MetadataAttribute"}},"version":{"description":"The version of the Article.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"variations":{"type":"array","description":"Variations of the Article.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"Faq":{"type":"object","properties":{"question":{"type":"string","description":"Question from the knowledge base that was matched to user request.","readOnly":true},"answer":{"type":"string","description":"Answer from the knowledge base corresponding to the identified question.","readOnly":true},"sourceUri":{"type":"string","description":"A URI uniquely identifying the document, e.g. projects/acme-inc/knowledgeBases/MTAyNjgxNDU1Nzc3NTM1NzU0MjQ/documents/MTI5ODc3NzQzOTQ5MTc5NzgxMTI.","readOnly":true},"documentUrl":{"type":"string","description":"URL pointing to a web page if document was sourced from a URL.","readOnly":true},"documentDisplayName":{"type":"string","description":"A human-readable description of the document, e.g. 'Sample store FAQ'","readOnly":true},"confidence":{"type":"number","format":"float","description":"Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all","readOnly":true}}},"MetadataAttribute":{"type":"object","properties":{"value":{"type":"string","description":"The value of the metadata attribute.","readOnly":true}}},"Suggestion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of the documents for which the suggestion is.","readOnly":true,"enum":["Faq","Article","KnowledgeArticle","KnowledgeSearch","CannedResponse","Script"]},"faq":{"description":"The Faq from the knowledgebase that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/Faq"},"article":{"description":"The article from the knowledgebase that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/Article"},"dateCreated":{"type":"string","format":"date-time","example":"2020-09-25T11:57:02Z","description":"Date when the suggestion was created. For example: yyyy-MM-ddTHH:mm:ss.SSZ. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"answerRecordId":{"type":"string","description":"The ID of the knowledge search that provided the suggestion.","readOnly":true},"triggerType":{"type":"string","description":"The trigger type of the suggestion.","readOnly":true,"enum":["Unknown","Fallback","ConversationStart","ConversationTransfer","ConversationEnd","Intent"]},"context":{"description":"The conversation context in which the suggestion was raised.","readOnly":true,"$ref":"#/definitions/SuggestionContext"},"state":{"type":"string","description":"The state of the suggestion.","readOnly":true,"enum":["Suggested","Accepted","Dismissed","Failed","Rated"]},"knowledgeSearch":{"description":"The suggested knowledge search result that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/SuggestionKnowledgeSearch"},"knowledgeArticle":{"description":"The suggested knowledge article that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/SuggestionKnowledgeArticle"},"cannedResponse":{"description":"The suggested canned response that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/SuggestionCannedResponse"},"script":{"description":"The suggested script that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/SuggestionScript"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"conversation":{"description":"The conversation that the suggestions correspond to.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"assistant":{"description":"The assistant that was used to provide the suggestions.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SuggestionCannedResponse":{"type":"object","properties":{"response":{"description":"The suggested response.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"library":{"description":"The library from which the canned response is suggested","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SuggestionContext":{"type":"object","properties":{"queue":{"description":"The queue used to assign the interaction to the user, if any.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"mediaType":{"type":"string","description":"The media type of the conversation in which the suggestion event was raised.","readOnly":true,"enum":["Message","Voice","Unknown"]},"user":{"description":"The agent participant who received the raised suggestion, if any.","readOnly":true,"$ref":"#/definitions/UserReference"},"externalContact":{"description":"The external contact of the end-user participant, if any.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"utterance":{"description":"The utterance in the voice conversation, after which the suggestion was raised, if any.","readOnly":true,"$ref":"#/definitions/Entity"},"message":{"description":"The message in the digital conversation, after which the suggestion was raised, if any.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"queryStatement":{"type":"string","description":"The query statement used when generating the suggestion, if any.","readOnly":true}}},"SuggestionKnowledgeAnswer":{"type":"object","properties":{"answer":{"type":"string","description":"The most relevant answer","readOnly":true},"startIndex":{"type":"integer","format":"int32","description":"The start index of the answer","readOnly":true},"endIndex":{"type":"integer","format":"int32","description":"The end index of the answer","readOnly":true}}},"SuggestionKnowledgeArticle":{"type":"object","properties":{"title":{"type":"string","description":"The article title.","readOnly":true},"snippets":{"type":"array","description":"Snippets of text from the article matching the query.","readOnly":true,"items":{"type":"string"}},"document":{"description":"The article.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"version":{"description":"The version of the article.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"knowledgeAnswer":{"description":"The most relevant answer within the suggested article.","readOnly":true,"$ref":"#/definitions/SuggestionKnowledgeAnswer"},"variations":{"type":"array","description":"The variations of the article.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"SuggestionKnowledgeSearch":{"type":"object","properties":{"title":{"type":"string","description":"The article title.","readOnly":true},"snippets":{"type":"array","description":"Snippets of text from the article matching the query.","readOnly":true,"items":{"type":"string"}},"confidence":{"type":"number","format":"float","description":"Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all.","readOnly":true},"searchId":{"type":"string","description":"The search id.","readOnly":true},"document":{"description":"The article matching the query.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"version":{"description":"The version of the article.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"knowledgeAnswer":{"description":"The most relevant answer within a searched article for the searched query","readOnly":true,"$ref":"#/definitions/SuggestionKnowledgeAnswer"},"variations":{"type":"array","description":"Variations of the article.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"SuggestionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Suggestion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"SuggestionScript":{"type":"object","properties":{"script":{"description":"The suggested script.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"page":{"description":"The page of the script.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"data":{"type":"object","description":"The payload for the script.","readOnly":true,"additionalProperties":{"type":"string"}}}},"SuggestionEngagement":{"type":"object","required":["engagementType"],"properties":{"engagementType":{"type":"string","description":"The type of engagement with the suggestion.","enum":["Dismissed","Copied","Opened","Feedback"]},"feedback":{"description":"The given feedback on the suggestion, if any.","$ref":"#/definitions/SuggestionFeedback"}}},"SuggestionFeedback":{"type":"object","required":["rating"],"properties":{"rating":{"type":"string","description":"The rating value of the suggestion feedback.","enum":["Negative","Positive"]}}},"ConversationEditedSummary":{"type":"object","properties":{"text":{"type":"string","description":"The text of the edited summary."},"dateModified":{"type":"string","format":"date-time","description":"The modification date of the edited summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ConversationSessionSummary":{"type":"object","properties":{"text":{"type":"string","description":"The text of the summary."},"status":{"type":"string","description":"The status of the conversation summary.","enum":["Pending","Queued","Started","Completed","Error","Processing"]},"mediaType":{"type":"string","description":"The media type of the conversation.","enum":["Email","Call","Chat","Message","Webmessaging","Unknown"]},"language":{"type":"string","description":"The language of the conversation."},"predictedWrapupCodes":{"type":"array","description":"The wrapup codes of the conversation summary.","items":{"$ref":"#/definitions/ConversationSummaryWrapupCode"}},"editedSummary":{"description":"The edited summary of the conversation.","$ref":"#/definitions/ConversationEditedSummary"},"reason":{"description":"The reason of the conversation summary.","$ref":"#/definitions/ConversationSummaryReason"},"followup":{"description":"The followup of the conversation summary.","$ref":"#/definitions/ConversationSummaryFollowup"},"resolution":{"description":"The resolution of the conversation summary.","$ref":"#/definitions/ConversationSummaryResolution"},"dateCreated":{"type":"string","format":"date-time","description":"The created date of the summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"id":{"type":"string","description":"The id of the summary.","readOnly":true},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true},"participants":{"type":"array","description":"The list of participants.","items":{"$ref":"#/definitions/AddressableEntityRef"}},"communication":{"description":"The communication object of the summary.","readOnly":true,"$ref":"#/definitions/Entity"}}},"ConversationSummariesGetResponse":{"type":"object","properties":{"conversation":{"description":"The conversation object.","$ref":"#/definitions/AddressableEntityRef"},"summary":{"description":"The summary of the conversation.","$ref":"#/definitions/ConversationSummary"},"sessionSummaries":{"type":"array","description":"All the summaries of the session.","items":{"$ref":"#/definitions/ConversationSessionSummary"}}},"description":"Defines the summaries of a conversation."},"ConversationSummary":{"type":"object","properties":{"text":{"type":"string","description":"The text of the summary."},"status":{"type":"string","description":"The status of the conversation summary.","enum":["Pending","Queued","Started","Completed","Error","Processing"]},"mediaType":{"type":"string","description":"The media type of the conversation.","enum":["Email","Call","Chat","Message","Webmessaging","Unknown"]},"language":{"type":"string","description":"The language of the conversation."},"predictedWrapupCodes":{"type":"array","description":"The wrapup codes of the conversation summary.","items":{"$ref":"#/definitions/ConversationSummaryWrapupCode"}},"editedSummary":{"description":"The edited summary of the conversation.","$ref":"#/definitions/ConversationEditedSummary"},"reason":{"description":"The reason of the conversation summary.","$ref":"#/definitions/ConversationSummaryReason"},"followup":{"description":"The followup of the conversation summary.","$ref":"#/definitions/ConversationSummaryFollowup"},"resolution":{"description":"The resolution of the conversation summary.","$ref":"#/definitions/ConversationSummaryResolution"},"dateCreated":{"type":"string","format":"date-time","description":"The created date of the summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"id":{"type":"string","description":"The id of the summary.","readOnly":true},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true},"participants":{"type":"array","description":"The list of participants.","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"ConversationSummaryFollowup":{"type":"object","properties":{"text":{"type":"string","description":"The text of the followup."},"description":{"type":"string","description":"The description."},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true}}},"ConversationSummaryReason":{"type":"object","properties":{"text":{"type":"string","description":"The text of the reason."},"description":{"type":"string","description":"The description."},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true}}},"ConversationSummaryResolution":{"type":"object","properties":{"text":{"type":"string","description":"The text of the resolution."},"description":{"type":"string","description":"The description."},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true},"outcome":{"type":"string","description":"The outcome of the conversation's resolution.","readOnly":true}}},"ConversationSummaryWrapupCode":{"type":"object","properties":{"name":{"type":"string","description":"The name of the wrapup code."},"description":{"type":"string","description":"The description of the wrapup code."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"id":{"type":"string","description":"The id of the wrapup code.","readOnly":true},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"]}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"externalContactInitialDivisionId":{"type":"string","description":"If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned."},"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"},"internalMessages":{"type":"array","items":{"$ref":"#/definitions/InternalMessage"}},"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"}}}},"CampaignPatchRequest":{"type":"object","properties":{"outboundLineCount":{"type":"integer","format":"int32","description":"The number of outbound lines to be concurrently dialed."},"abandonRate":{"type":"number","description":"The targeted compliance abandon rate percentage"},"maxCallsPerAgent":{"type":"number","description":"The maximum number of calls that can be placed per agent on this campaign"},"dynamicLineBalancingSettings":{"description":"Dynamic line balancing settings","$ref":"#/definitions/DynamicLineBalancingSettingsPatchRequest"},"queue":{"description":"The Queue for this Campaign to route calls to.","$ref":"#/definitions/AddressableEntityRef"}},"description":"Campaign patch request"},"DynamicLineBalancingSettingsPatchRequest":{"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"}}},"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},"filteredOutContactsCount":{"type":"integer","format":"int32","description":"Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on.","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"]}}}},"PagedSkillCombinationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SkillCombinationInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"SkillCombinationInfo":{"type":"object","properties":{"skillCombination":{"type":"array","description":"A skill combination in the contact queue","items":{"type":"string"}},"totalCount":{"type":"integer","format":"int64","description":"Number of total contacts in the contact queue for this skill combination","readOnly":true},"remainingCount":{"type":"integer","format":"int64","description":"Number of remaining contacts in the contact queue for this skill combination","readOnly":true}}},"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."},"campaignRuleProcessing":{"type":"string","description":"CampaignRule processing algorithm","enum":["v2"]},"conditionGroups":{"type":"array","description":"List of condition groups that are evaluated, used only with campaignRuleProcessing=\"v2\"","items":{"$ref":"#/definitions/CampaignRuleConditionGroup"}},"executionSettings":{"description":"CampaignRule execution settings","$ref":"#/definitions/CampaignRuleExecutionSettings"},"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","setCampaignMessagesPerMinute","changeCampaignQueue","changeCampaignTemplate"]},"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","campaignRecordsAttempted","campaignContactsMessaged","campaignBusinessSuccess","campaignBusinessFailure","campaignBusinessNeutral","campaignValidAttempts","campaignRightPartyContacts"]}}},"CampaignRuleConditionGroup":{"type":"object","required":["conditions","matchAnyConditions"],"properties":{"matchAnyConditions":{"type":"boolean","description":"Whether or not this condition group should be evaluated as true if any of sub conditions is matched"},"conditions":{"type":"array","description":"The parameters for the CampaignRuleCondition.","items":{"$ref":"#/definitions/CampaignRuleCondition"}}}},"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"}}}},"CampaignRuleExecutionSettings":{"type":"object","required":["frequency"],"properties":{"frequency":{"type":"string","description":"Execution control frequency","enum":["onEachTrigger","oncePerDay"]},"timeZoneId":{"type":"string","example":"Africa/Abidjan","description":"The time zone for the execution control frequency=\"oncePerDay\"; for example, Africa/Abidjan. This property is ignored when frequency is not \"oncePerDay\""}}},"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"]},"abandonRate":{"type":"number","description":"The abandon rate to set a campaign to. Required for the 'setCampaignAbandonRate' action."},"outboundLineCount":{"type":"integer","format":"int32","description":"The number of outbound lines to set a campaign to. Required for the 'setCampaignNumberOfLines' action."},"relativeWeight":{"type":"integer","format":"int32","description":"The relative weight to set a campaign to. Required for the 'setCampaignWeight' action."},"maxCallsPerAgent":{"type":"number","description":"The maximum number of calls per agent to set a campaign to. Required for the 'setCampaignMaxCallsPerAgent' action."},"queue":{"description":"The queue a campaign to. Required for the 'changeCampaignQueue' action.","$ref":"#/definitions/DomainEntityRef"},"messagesPerMinute":{"type":"integer","format":"int32","description":"The number of messages per minute to set a messaging campaign to."},"smsContentTemplate":{"description":"The content template to set a SMS campaign to.","$ref":"#/definitions/DomainEntityRef"},"emailContentTemplate":{"description":"The content template to set a Email campaign to.","$ref":"#/definitions/DomainEntityRef"}}},"CampaignRuleWarning":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Warning code for this warning.","enum":["ConditionsNoEntities","ConditionsNoSequences","ConditionsNoCampaigns","ConditionsNoMessagingCampaigns","ActionNoEntities","ActionNoSequences","ActionNoCampaigns","ActionNoMessagingCampaigns","NoQueue","NoContentTemplates","NoSmsContentTemplate","NoEmailContentTemplate"]},"message":{"type":"string","description":"Warning message for this warning."},"params":{"description":"Additional warning information","$ref":"#/definitions/CampaignRuleWarningParameters"}}},"CampaignRuleWarningParameters":{"type":"object","properties":{"actionId":{"type":"string","description":"ID of action"},"conditionId":{"type":"string","description":"ID of condition"},"actionType":{"type":"string","description":"Type of action","enum":["turnOnCampaign","turnOffCampaign","turnOnSequence","turnOffSequence","setCampaignPriority","recycleCampaign","setCampaignDialingMode","setCampaignAbandonRate","setCampaignNumberOfLines","setCampaignWeight","setCampaignMaxCallsPerAgent","setCampaignMessagesPerMinute","changeCampaignQueue","changeCampaignTemplate"]},"conditionType":{"type":"string","description":"Type of condition","enum":["campaignProgress","campaignAgents","campaignRecordsAttempted","campaignContactsMessaged","campaignBusinessSuccess","campaignBusinessFailure","campaignBusinessNeutral","campaignValidAttempts","campaignRightPartyContacts"]}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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/DivisionedDomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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}}},"DivisionedDomainEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"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","example":"America/New_York","description":"The time zone for the recurrence. The time zone of the recurrence is determined by prioritizing the recurrence's time zone if specified, then the schedule's time zone if set, and finally defaulting to UTC if neither defines a time zone."},"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"}}},"CampaignBusinessCategoryMetrics":{"type":"object","properties":{"successCount":{"type":"integer","format":"int32","description":"Number of calls categorized as business success"},"neutralCount":{"type":"integer","format":"int32","description":"Number of calls categorized as business neutral"},"failureCount":{"type":"integer","format":"int32","description":"Number of calls categorized as business failure"}}},"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},"filteredOutContactsCount":{"type":"integer","format":"int32","description":"Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on.","readOnly":true},"rightPartyContactsCount":{"type":"integer","format":"int32","description":"Information on the campaign's number of Right Party Contacts","readOnly":true},"validAttempts":{"type":"integer","format":"int32","description":"Information on the campaign's valid attempts","readOnly":true},"linesUtilization":{"description":"Information on the campaign's lines utilization","readOnly":true,"$ref":"#/definitions/CampaignLinesUtilization"},"businessCategoryMetrics":{"description":"Information on the campaign's business category metrics","readOnly":true,"$ref":"#/definitions/CampaignBusinessCategoryMetrics"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}}},"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"}}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"ContactsBulkOperationJobListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"selfUri":{"type":"string","format":"uri"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","ANOTHER_CAMPAIGN_STARTING","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","QUEUE_NOT_FOUND","RECYCLE_CAMPAIGN","SCHEDULED_CAMPAIGN_INVALID","SCHEDULE_UNKNOWN_ERROR","SMS_CONTENT_TEMPLATE_NOT_FOUND","RECURRING_SCHEDULE_NEXT_OCCURRENCE_FAILURE","RECURRING_SCHEDULE_ENDED","RECURRING_SCHEDULE_MISSED_OCCURRENCES","VERSION_CONFLICT"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","BUSINESS_SUCCESS","BUSINESS_FAILURE","BUSINESS_NEUTRAL"]}},"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","BUSINESS_SUCCESS","BUSINESS_FAILURE","BUSINESS_NEUTRAL"]}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","forced_stopping"]},"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},"filteredOutContactsCount":{"type":"integer","format":"int32","description":"Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on.","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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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/DivisionedDomainEntityRef"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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/DivisionedDomainEntityRef"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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/Image"}},"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"},"includeOwners":{"type":"boolean","description":"Allow owners to be included as members of the group"},"callsEnabled":{"type":"boolean","description":"Allow calls to be placed 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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/Image"}},"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"},"includeOwners":{"type":"boolean","description":"Allow owners to be included as members of the group"},"callsEnabled":{"type":"boolean","description":"Allow calls to be placed 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","WorkitemId","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","WorkitemId","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."},"workitemId":{"type":"string","description":"The id of the workitem 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."},"flowWarningReason":{"type":"string","description":"If the flow had a warning, 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","internalmessage","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"}}},"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}}},"GetProfilesResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/PerformanceProfile"}},"selfUri":{"type":"string","format":"uri"}}},"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","internalmessage","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","internalmessage","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"}}},"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"}}},"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","internalmessage","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","description":"Social Handle Type","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"]},"existingValue":{"type":"string"},"updatedValue":{"type":"string"}}},"SocialHandle":{"type":"object","properties":{"type":{"type":"string","description":"Social Handle Type","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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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/Image"}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"TrustedCertificateInfo":{"type":"object","properties":{"description":{"type":"string","description":"The description of the certificate"},"serialNumber":{"type":"string","description":"The serial number of the certificate"},"signature":{"type":"string","description":"The signature of the certificate"}}},"TrustedCertificates":{"type":"object","properties":{"entities":{"type":"array","description":"The list of trusted certificates","items":{"$ref":"#/definitions/TrustedCertificateInfo"}},"total":{"type":"integer","format":"int32","description":"The total number of trusted certificates"}},"description":"Information about trusted certificates"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"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"},"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."},"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"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"AudioConnectorIntegration":{"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}}},"AudioConnectorIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AudioConnectorIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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":"(deprecated - use triggerWithOutcomeQuantileConditions instead) 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":"(deprecated - use triggerWithOutcomeQuantileConditions instead) 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"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."}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}},"charts":{"type":"array","description":"A list of charts to measure within context of the elements of the the journey view","items":{"$ref":"#/definitions/JourneyViewChart"}},"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"},"displayAttributes":{"description":"Attributes that defines the visualization of the element in the journey view","$ref":"#/definitions/JourneyViewElementDisplayAttributes"},"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"},"JourneyViewElementDisplayAttributes":{"type":"object","required":["col","x","y"],"properties":{"x":{"type":"integer","format":"int32","description":"The horizontal position (x-coordinate) of the element on the journey view canvas"},"y":{"type":"integer","format":"int32","description":"The vertical position (y-coordinate) of the element on the journey view canvas"},"col":{"type":"integer","format":"int32","description":"The column position for the element in the journey view canvas"}},"description":"Display attributes for an element in a journey view"},"JourneyViewElementFilter":{"type":"object","required":["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"},"JourneyViewElementFilterNumberPredicate":{"type":"object","required":["dimension","range"],"properties":{"dimension":{"type":"string","description":"the element's attribute being filtered on"},"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"},"range":{"description":"the range of comparators to filter on","$ref":"#/definitions/JourneyViewElementFilterRange"}},"description":"A numeric filter 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"},"JourneyViewElementFilterRange":{"type":"object","properties":{"lt":{"description":"comparator: less than","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"lte":{"description":"comparator: less than or equal","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"gt":{"description":"comparator: greater than","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"gte":{"description":"comparator: greater than or equal","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"eq":{"description":"comparator: is equal to","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"neq":{"description":"comparator: is not equal to","$ref":"#/definitions/JourneyViewElementFilterRangeData"}},"description":"the range of attribute values to filter on. At least one comparator must be defined"},"JourneyViewElementFilterRangeData":{"type":"object","properties":{"duration":{"type":"string","description":"An ISO 8601 time duration. Only one of number or duration must be specified."},"number":{"type":"number","format":"double","description":"A numeric value. Only one of number or duration must be specified."}}},"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":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","Cancelled"]},"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}}},"JourneyViewJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyViewJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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 "},"JourneyViewSchedule":{"type":"object","required":["dateModified","frequency","user"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"frequency":{"type":"string","description":"Frequency of execution","enum":["Daily","Weekly","Monthly"]},"dateModified":{"type":"string","format":"date-time","description":"Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"user":{"description":"Last modified user","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JourneyViewScheduleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyViewSchedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."}}},"KnowledgeIntegrationFilter":{"type":"object","properties":{"name":{"type":"string","description":"Filter name, which is the name of a setting in a knowledge source.","enum":["categories","channel","knowledgeBaseIds"]},"type":{"type":"string","description":"Filter type.","enum":["SingleSelect","MultiSelect"]},"action":{"type":"string","description":"Filter action.","enum":["None","FilterUpdate"]},"values":{"type":"array","description":"Available options of the filter setting.","items":{"$ref":"#/definitions/KnowledgeIntegrationFilterValue"}}}},"KnowledgeIntegrationFilterValue":{"type":"object","properties":{"key":{"type":"string","description":"The key that can be used as a value of a filter setting in a knowledge source."},"value":{"type":"string","description":"The display label of the filter value."}}},"KnowledgeIntegrationOptionsResponse":{"type":"object","properties":{"filters":{"type":"array","description":"Filter setting options available for a knowledge source.","items":{"$ref":"#/definitions/KnowledgeIntegrationFilter"}}}},"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, 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"]}}},"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}}},"KnowledgeIntegrationReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the integration."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SourceBaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the source."},"dateCreated":{"type":"string","format":"date-time","description":"Source 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":"Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The source type.","enum":["Salesforce","ServiceNow"]},"integration":{"description":"The reference to the integration associated with the source.","$ref":"#/definitions/KnowledgeIntegrationReference"},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours."},"lastSync":{"description":"Additional information about the last synchronization of the source.","$ref":"#/definitions/SourceLastSync"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SourceLastSync":{"type":"object","properties":{"state":{"type":"string","description":"State of the last synchronization.","enum":["Success","Failed","InProgress","Unknown"]},"dateStarted":{"type":"string","format":"date-time","description":"Last synchronization start-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnded":{"type":"string","format":"date-time","description":"Last synchronization end-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"error":{"description":"Optional error message of the last synchronization.","$ref":"#/definitions/ErrorBody"}}},"SalesforceSettings":{"type":"object","properties":{"channel":{"type":"string","description":"Filter source by channel.","enum":["App","Pkb","Csp","Prm"]},"language":{"type":"string","description":"Filter source by language."},"categories":{"type":"array","description":"Filter source by categories.","items":{"type":"string"}}}},"SalesforceSourceResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the source."},"dateCreated":{"type":"string","format":"date-time","description":"Source 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":"Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The source type.","enum":["Salesforce","ServiceNow"]},"integration":{"description":"The reference to the integration associated with the source.","$ref":"#/definitions/KnowledgeIntegrationReference"},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours."},"lastSync":{"description":"Additional information about the last synchronization of the source.","$ref":"#/definitions/SourceLastSync"},"settings":{"description":"The settings of the source.","$ref":"#/definitions/SalesforceSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SalesforceSourceRequest":{"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 integration source."},"integrationId":{"type":"string","description":"The integration associated with the source."},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours. Must be at least 6 and at most 48 hours.","minimum":6,"maximum":48},"settings":{"description":"The settings of the source.","$ref":"#/definitions/SalesforceSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SourceSyncResponse":{"type":"object","properties":{"state":{"type":"string","description":"Sync state.","enum":["Success","Failed","InProgress","Unknown"]},"error":{"description":"Sync error.","$ref":"#/definitions/ErrorBody"},"dateCreated":{"type":"string","format":"date-time","description":"Synchronization creation date-time for this source. 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":"Synchronization last modification date-time for this source. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"knowledgeBase":{"description":"Knowledge base to which this synchronization belongs.","$ref":"#/definitions/AddressableEntityRef"},"source":{"description":"Source to which this synchronization belongs.","$ref":"#/definitions/AddressableEntityRef"}}},"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}}},"KnowledgeSyncJobReport":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors occurred during processing sync.","items":{"$ref":"#/definitions/ErrorBody"}},"statistics":{"description":"Statistics related to the sync job.","$ref":"#/definitions/KnowledgeSyncJobStatistics"}}},"KnowledgeSyncJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the sync job."},"uploadKey":{"type":"string"},"status":{"type":"string","description":"The status of the export job.","enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]},"report":{"description":"Report of the sync job","$ref":"#/definitions/KnowledgeSyncJobReport"},"knowledgeBase":{"description":"Knowledge base which document export belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"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"},"createdBy":{"description":"The user who created the operation","$ref":"#/definitions/UserReference"},"downloadURL":{"type":"string","description":"The URL of the location at which the caller can download the sync file, when available."},"failedEntitiesURL":{"type":"string","description":"The URL of the location at which the caller can download the entities in json format that failed during the sync."},"source":{"description":"Source of the sync job.","$ref":"#/definitions/KnowledgeOperationSource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSyncJobStatistics":{"type":"object","properties":{"countDocumentImportActivityCreate":{"type":"integer","format":"int32","description":"Number of documents will be created by the sync."},"countDocumentImportActivityUpdate":{"type":"integer","format":"int32","description":"Number of documents will be updated by the sync."},"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."},"countDocumentImportSuccess":{"type":"integer","format":"int32","description":"Number of imported documents."},"countDocumentImportFailure":{"type":"integer","format":"int32","description":"Number of documents failed to import."},"countCategoryImportSuccess":{"type":"integer","format":"int32","description":"Number of imported categories."},"countCategoryImportFailure":{"type":"integer","format":"int32","description":"Number of categories failed to import."},"countLabelImportSuccess":{"type":"integer","format":"int32","description":"Number of imported labels."},"countLabelImportFailure":{"type":"integer","format":"int32","description":"Number of labels failed to import."},"countDocumentDeleteSuccess":{"type":"integer","format":"int32","description":"Number of documents will be deleted by the sync."},"countDocumentDeleteFailure":{"type":"integer","format":"int32","description":"Number of documents failed to delete."},"countCategoryDeleteSuccess":{"type":"integer","format":"int32","description":"Number of successfully deleted categories."},"countCategoryDeleteFailure":{"type":"integer","format":"int32","description":"Number of categories failed to delete."},"countLabelDeleteSuccess":{"type":"integer","format":"int32","description":"Number of successfully deleted labels."},"countLabelDeleteFailure":{"type":"integer","format":"int32","description":"Number of labels failed to delete."}}},"ServiceNowSettings":{"type":"object","properties":{"knowledgeBaseIds":{"type":"array","description":"Filter source by knowledge base ids.","items":{"type":"string"}},"language":{"type":"string","description":"Filter source by language."},"categories":{"type":"array","description":"Filter source by categories.","items":{"type":"string"}}}},"ServiceNowSourceResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the source."},"dateCreated":{"type":"string","format":"date-time","description":"Source 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":"Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The source type.","enum":["Salesforce","ServiceNow"]},"integration":{"description":"The reference to the integration associated with the source.","$ref":"#/definitions/KnowledgeIntegrationReference"},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours."},"lastSync":{"description":"Additional information about the last synchronization of the source.","$ref":"#/definitions/SourceLastSync"},"settings":{"description":"The settings of the source.","$ref":"#/definitions/ServiceNowSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceNowSourceRequest":{"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 integration source."},"integrationId":{"type":"string","description":"The integration associated with the source."},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours. Must be at least 6 and at most 48 hours.","minimum":6,"maximum":48},"settings":{"description":"The settings of the source.","$ref":"#/definitions/ServiceNowSettings"},"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"}}},"AnswerGenerationDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"The document title."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraphWithHighlight"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListWithHighlight"},"table":{"description":"Table. It must contain a value if type of the block is Table.","$ref":"#/definitions/DocumentBodyTableWithHighlight"}}},"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":{"properties":{"description":"Properties for the UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListBlockProperties"},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentBodyListBlock"}}}},"DocumentBodyListBlock":{"type":"object","required":["blocks","type"],"properties":{"type":{"type":"string","description":"The type of the list block.","enum":["ListItem"]},"properties":{"description":"The properties for the list block.","$ref":"#/definitions/DocumentBodyListItemProperties"},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentListContentBlock"}}}},"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"]}}},"DocumentBodyListBlockWithHighlight":{"type":"object","required":["blocks","type"],"properties":{"type":{"type":"string","description":"The type of the list block.","enum":["ListItem"]},"properties":{"description":"The properties for the list block.","$ref":"#/definitions/DocumentBodyListItemProperties"},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentListContentBlockWithHighlight"}}}},"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"]}}},"DocumentBodyListWithHighlight":{"type":"object","required":["blocks"],"properties":{"properties":{"description":"Properties for the UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListBlockProperties"},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentBodyListBlockWithHighlight"}}}},"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"}}},"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"}}},"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 of the table cell converted to em unit."},"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."}}},"DocumentBodyTableCellBlockWithHighlight":{"type":"object","required":["blocks"],"properties":{"properties":{"description":"The properties for the table cell.","$ref":"#/definitions/DocumentBodyTableCellBlockProperties"},"blocks":{"type":"array","description":"The list of content blocks for the table.","items":{"$ref":"#/definitions/DocumentTableContentBlockWithHighlight"}}}},"DocumentBodyTableProperties":{"type":"object","properties":{"width":{"type":"number","format":"float","description":"The width of the table converted to em unit."},"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"}}},"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"}}},"DocumentBodyTableRowBlockWithHighlight":{"type":"object","required":["cells"],"properties":{"properties":{"description":"The properties for the table rows.","$ref":"#/definitions/DocumentBodyTableRowBlockProperties"},"cells":{"type":"array","description":"The list of cells for the table.","items":{"$ref":"#/definitions/DocumentBodyTableCellBlockWithHighlight"}}}},"DocumentBodyTableWithHighlight":{"type":"object","required":["rows"],"properties":{"properties":{"description":"The properties for the table.","$ref":"#/definitions/DocumentBodyTableProperties"},"rows":{"type":"array","description":"The list of rows for the table.","items":{"$ref":"#/definitions/DocumentBodyTableRowBlockWithHighlight"}}}},"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."}}},"DocumentElementLength":{"type":"object","required":["unit","value"],"properties":{"value":{"type":"number","format":"float","description":"The length value of the element in the selected unit."},"unit":{"type":"string","description":"The unit of length.","enum":["Em","Percentage","Px"]}}},"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"},"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"}}},"DocumentListContentBlockWithHighlight":{"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"},"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/DocumentBodyListWithHighlight"},"answerHighlight":{"description":"The block highlight data.","$ref":"#/definitions/DocumentContentHighlightIndex"}}},"DocumentTableContentBlockWithHighlight":{"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"]},"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"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraphWithHighlight"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListWithHighlight"},"table":{"description":"Table. It must contain a value if the type of the block is Table.","$ref":"#/definitions/DocumentBodyTableWithHighlight"},"answerHighlight":{"description":"The block highlight data.","$ref":"#/definitions/DocumentContentHighlightIndex"}}},"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"}}}},"KnowledgeAnswerDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The document id."},"title":{"type":"string","description":"The document title."},"answer":{"type":"string","description":"The answer found inside a variationContent."},"variation":{"description":"The variation with the answer's highlight data.","$ref":"#/definitions/DocumentVariationAnswer"}}},"KnowledgeAnswerDocumentsResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results with answers if the answerMode request property is not set or contains \"AnswerHighlight\". Empty array otherwise.","items":{"$ref":"#/definitions/KnowledgeAnswerDocumentResponse"}},"answerGeneration":{"description":"The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\".","$ref":"#/definitions/KnowledgeAnswerGenerationResponse"}}},"KnowledgeAnswerGenerationResponse":{"type":"object","properties":{"answer":{"type":"string","description":"The AI-generated answer."},"documents":{"type":"array","description":"The documents used for answer generation.","items":{"$ref":"#/definitions/AnswerGenerationDocument"}}}},"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}}},"KnowledgeDocumentsAnswerFilter":{"type":"object","required":["variationIds"],"properties":{"query":{"type":"string","description":"The search query."},"language":{"type":"string","description":"The language of the documents.","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"]},"appType":{"type":"string","description":"The appType","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},"queryType":{"type":"string","description":"The query type","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"searchId":{"type":"string","description":"The search id."},"insertHighlightIntoVariationContent":{"type":"boolean","description":"If specified - insert highlight data into the variation content."},"answerMode":{"type":"array","description":"Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight","items":{"type":"string","enum":["AnswerHighlight","AnswerGeneration"]}},"variationIds":{"type":"array","description":"The variation Ids to answer.","items":{"type":"string"},"maxItems":10,"minItems":1}}},"ContentFileResponse":{"type":"object","required":["checksum","contentUrl","name","size","type"],"properties":{"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The file format","enum":["Pdf","Docx","Doc"]},"checksum":{"type":"string","description":"The checksum of the file"},"size":{"type":"integer","format":"int64","description":"The size of the file in bytes"},"contentUrl":{"type":"string","description":"Public download url for content. Needs to be expanded"}}},"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"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"},"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"}}},"DocumentBodyResponse":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the document body.","items":{"$ref":"#/definitions/DocumentBodyBlock"}}}},"DocumentBodyTable":{"type":"object","required":["rows"],"properties":{"properties":{"description":"The properties for the table.","$ref":"#/definitions/DocumentBodyTableProperties"},"rows":{"type":"array","description":"The list of rows for the table.","items":{"$ref":"#/definitions/DocumentBodyTableRowBlock"}}}},"DocumentBodyTableCellBlock":{"type":"object","required":["blocks"],"properties":{"properties":{"description":"The properties for the table cell.","$ref":"#/definitions/DocumentBodyTableCellBlockProperties"},"blocks":{"type":"array","description":"The list of content blocks for the table.","items":{"$ref":"#/definitions/DocumentTableContentBlock"}}}},"DocumentBodyTableRowBlock":{"type":"object","required":["cells"],"properties":{"properties":{"description":"The properties for the table rows.","$ref":"#/definitions/DocumentBodyTableRowBlockProperties"},"cells":{"type":"array","description":"The list of cells for the table.","items":{"$ref":"#/definitions/DocumentBodyTableCellBlock"}}}},"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"]},"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"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"},"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"}}},"DocumentVariationResponse":{"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/DocumentBodyResponse"},"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."}}},"KnowledgeDocumentDescriptor":{"type":"object","properties":{}},"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."},"externalUrl":{"type":"string","description":"The URL to external 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/DocumentVariationResponse"}},"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"}}},"KnowledgeDocumentCreateRequest":{"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}}},"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"}}}},"WritableEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"ContentFileRequest":{"type":"object","properties":{"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name"},"name":{"type":"string","description":"The name of the file"}}},"DocumentBodyRequest":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the document body.","items":{"$ref":"#/definitions/DocumentBodyBlock"}}}},"DocumentVariationRequest":{"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/DocumentBodyRequest"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentVariationResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DocumentVariationResponse"}},"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/DocumentBodyResponse"},"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}}},"KnowledgeDocumentFeedbackUpdateRequest":{"type":"object","required":["rating"],"properties":{"rating":{"type":"string","description":"Feedback rating.","enum":["Negative","Positive"]},"reason":{"type":"string","description":"Feedback reason","enum":["DocumentContent","SearchResults"]},"comment":{"type":"string","description":"Feedback comment"},"state":{"type":"string","description":"Feedback state","enum":["Draft","Final"]}}},"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"}}},"KnowledgeDocumentQueryResponse":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"total":{"type":"integer","format":"int64","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages of results, calculated according to the pageSize and the total matching documents.","readOnly":true},"results":{"type":"array","description":"Documents matching the query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeDocumentResponse"}}}},"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"]}}},"KnowledgeDocumentQuery":{"type":"object","required":["filter"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the 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 query.","$ref":"#/definitions/DocumentQuery"},"includeVariations":{"type":"string","description":"Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All.","enum":["All","AllMatching","SingleMostRelevant"]},"sortOrder":{"type":"string","description":"The sort order for results.","enum":["Asc","Desc"]},"sortBy":{"type":"string","description":"The field in the documents that you want to sort the results by.","enum":["DateCreated","DateModified","CategoryName","LabelName","ViewCount"]}}},"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"},"includeDocumentsWithFileBody":{"type":"boolean"}}},"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."}}},"SyncStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"New status for an existing sync operation","enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]}}},"KnowledgeSyncJobRequest":{"type":"object","required":["uploadKey"],"properties":{"uploadKey":{"type":"string","description":"Upload key"},"sourceId":{"type":"string","description":"Knowledge integration source id."}}},"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}}},"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"}}},"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."},"answerGeneration":{"description":"The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\".","$ref":"#/definitions/KnowledgeAnswerGenerationResponse"}}},"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."},"externalUrl":{"type":"string","description":"The URL to external 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},"answerMode":{"type":"array","description":"Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight. Use this property with answerHighlightTopResults.","items":{"type":"string","enum":["AnswerHighlight","AnswerGeneration"]}}}},"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."},"description":{"type":"string","description":"The description 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":["AI","DynamicList","List","Regex","Unknown"]},"subType":{"type":"string","description":"Subtype of detection mechanism","enum":["Alphanumeric","NumberSequence","FreeForm"]},"maxLength":{"type":"integer","format":"int32","description":"The maximum length of the entity resolved value"},"examples":{"type":"array","description":"Examples for entity detection","items":{"$ref":"#/definitions/NamedEntityTypeMechanismExample"}}}},"NamedEntityTypeMechanismExample":{"type":"object","required":["resolvedValue","text"],"properties":{"text":{"type":"string","description":"Example input text"},"resolvedValue":{"type":"string","description":"Resolved entity value"}}},"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},"source":{"type":"string","description":"The source of the utterance.","enum":["Generated","User"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","it-it","nl-nl"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"LimitCount":{"type":"object","properties":{"name":{"type":"string","description":"The name of the limit."},"estimatedCount":{"type":"integer","format":"int64","description":"The total used count of the limit."},"max":{"type":"integer","format":"int64","description":"The maximum value of the limit."},"entityId":{"type":"string","description":"The entity which makes this count unique. The context of what the entity is would be dependant on the limit. May not be applicable for all limits."},"userId":{"type":"string","description":"The user which makes this count unique. May not be applicable for all limits."}}},"LimitCountListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LimitCount"}},"nextUri":{"type":"string","description":"A URI to the next page in the listing."},"selfUri":{"type":"string","description":"A URI to the current page in the listing."}}},"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","business.rules","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gamification","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","internal.messaging","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","business.rules","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gamification","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","internal.messaging","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","business.rules","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gamification","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","internal.messaging","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":{"name":{"type":"string"},"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":{"name":{"type":"string"},"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},"dateStarted":{"type":"string","format":"date-time","description":"Indicates when log capture was enabled for the user. 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":"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."},"contentSizeBytes":{"type":"integer","format":"int64","description":"Size in bytes of the attachment content."}},"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","Share","Comment","View"]},"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","Topic"]},"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},"externalContactId":{"type":"string","description":"The identifier of the external contact."},"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","Topic","IngestionRule","IngestionRuleVersion"]},"value":{"type":"string","description":"The Identifier value.","readOnly":true}},"description":"Additional identifiers for describing messaging recipient."},"IpAddressRange":{"type":"object","properties":{"cidr":{"type":"string"},"service":{"type":"string","enum":["data-actions","smtp","audiohook","open-messaging","api","audio-connector","byot-stt","bot-connector"]},"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."}}},"ResponsePage":{"type":"object","required":["domain","hostname","pathname","title","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 tag of the page."},"lang":{"type":"string","description":"ISO 639-1 language code for the page as defined in the 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."}}},"WebEventBrowser":{"type":"object","required":["family","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."}}},"WebEventDevice":{"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."},"osFamily":{"type":"string","description":"Operating system family."},"osVersion":{"type":"string","description":"Operating system version."},"manufacturer":{"type":"string","description":"Manufacturer of the device."}}},"WebEventResponse":{"type":"object","required":["attributes","authenticated","browser","createdDate","customerId","customerIdType","device","eventName","page","session","traits","userAgentString"],"properties":{"customerId":{"type":"string","description":"Identifier of the customer in the source of the event."},"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. page_viewed, order_completed, user_registered."},"customerIdType":{"type":"string","description":"Type of identifier for the customer ID (e.g., cookie)."},"page":{"description":"The webpage where the user interaction occurred.","$ref":"#/definitions/ResponsePage"},"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/WebEventBrowser"},"device":{"description":"Customer's device.","$ref":"#/definitions/WebEventDevice"},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"mktCampaign":{"description":"Urchin Tracking Module (UTM) parameters used to track the effectiveness of online marketing campaigns.","$ref":"#/definitions/JourneyCampaign"},"session":{"description":"The session that the event belongs to.","$ref":"#/definitions/WebEventResponseSession"},"referrer":{"description":"Identifies the web page 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. 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"}},"authenticated":{"type":"boolean","description":"Indicates whether the event was produced during an authenticated session."},"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"}}},"WebEventResponseSession":{"type":"object","required":["createdDate","durationInSeconds","eventCount","pageviewCount"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"durationInSeconds":{"type":"integer","format":"int32","description":"Indicates how long the customer has been on the site within this session."},"eventCount":{"type":"integer","format":"int32","description":"The count of all events recorded during this session."},"pageviewCount":{"type":"integer","format":"int32","description":"The count of all pageviews performed during this session."},"referrer":{"description":"The referrer of the first event in the web session.","$ref":"#/definitions/Referrer"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date 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"}}},"RequestPage":{"type":"object","required":["title","url"],"properties":{"url":{"type":"string","description":"The page URL."},"title":{"type":"string","description":"Title of the page."},"keywords":{"type":"string","description":"Keywords from the HTML tag of the page."},"lang":{"type":"string","description":"ISO 639-1 language code for the page as defined in the tag."}}},"WebEventRequest":{"type":"object","required":["createdDate","customerCookieId","eventName","page"],"properties":{"customerCookieId":{"type":"string","description":"A UUID representing the customer making the request."},"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. page_viewed, order_completed, user_registered."},"page":{"description":"The webpage where the user interaction occurred.","$ref":"#/definitions/RequestPage"},"userAgentString":{"type":"string","description":"Override for HTTP User-Agent string from request header (see https://tools.ietf.org/html/rfc1945#section-10.15)."},"browser":{"description":"Customer's browser.","$ref":"#/definitions/WebEventBrowser"},"device":{"description":"Customer's device.","$ref":"#/definitions/WebEventDevice"},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"ipAddress":{"type":"string","description":"Customer's IP address."},"referrerUrl":{"type":"string","description":"Identifies the referrer URL that originally generated the request for the current page being viewed."},"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"}},"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"}}},"KnowledgeGuestAnswerDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The document id."},"title":{"type":"string","description":"The document title."},"answer":{"type":"string","description":"The answer found inside a variationContent."},"variation":{"description":"The variation with the answer's highlight data.","$ref":"#/definitions/KnowledgeGuestDocumentVariationAnswer"}}},"KnowledgeGuestAnswerDocumentsResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results with answers.","items":{"$ref":"#/definitions/KnowledgeGuestAnswerDocumentResponse"}}}},"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/DocumentBodyResponse"},"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}}},"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."}}},"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."}}},"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"}},"journeySessionId":{"type":"string","description":"Journey session ID. Used to get the segments of the customer to filter search results."}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"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"}}}},"EventQueryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OperationalEvent"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"OperationalEvent":{"type":"object","properties":{"eventDefinition":{"description":"The event that occurred.","$ref":"#/definitions/AddressableEntityRef"},"entityId":{"type":"string","description":"The unique identifier for the entity"},"entityName":{"type":"string","description":"The name for the entity"},"previousValue":{"type":"string","description":"The value prior to the event"},"currentValue":{"type":"string","description":"The changed value following the event"},"errorCode":{"type":"string","description":"The error code of the entity in the providing service associated to the event"},"parentEntityId":{"type":"string","description":"The unique identifier for the parent of the entity"},"conversation":{"description":"The link to a conversation","$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the event created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"entityVersion":{"type":"string","description":"The version of the entity in the providing service"}}},"EventQueryRequest":{"type":"object","required":["interval"],"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"},"eventDefinitionIds":{"type":"array","description":"Filter events by a list of event definition ids","items":{"type":"string"}},"searchTerm":{"type":"string","description":"Only return events that contain the search term"},"sortOrder":{"type":"string","description":"Order of results. Default order is DESC.","enum":["ASC","DESC"]}}},"EventAggregatesResponse":{"type":"object","properties":{"interval":{"type":"string","description":"Interval for returned aggregates. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"eventDefinitionAggregates":{"type":"array","description":"Aggregates by event definition","items":{"$ref":"#/definitions/EventDefinitionAggregates"}}}},"EventDefinitionAggregates":{"type":"object","properties":{"eventDefinition":{"description":"Event definition.","$ref":"#/definitions/AddressableEntityRef"},"eventCount":{"type":"integer","format":"int32","description":"How many events have occurred."}}},"EventAggregatesQueryRequest":{"type":"object","required":["interval"],"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"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"hasFullAccess":{"type":"boolean","description":"Denotes if trustee uses full access role by default."},"isTrustedUser":{"type":"boolean","description":"Denotes if trustee is given Trusted User access 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}}},"TrusteeReferenceList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"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/Image"}},"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"},"includeOwners":{"type":"boolean","description":"Allow owners to be included as members of the group"},"callsEnabled":{"type":"boolean","description":"Allow calls to be placed 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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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/Image"}},"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"},"workPlanBidRanks":{"description":"The WFM work plan bid rank settings for the user","readOnly":true,"$ref":"#/definitions/WorkPlanBidRanks"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"label":{"description":"This specifies the interaction label scoped to this estimated wait time calculation","$ref":"#/definitions/AddressableEntityRef"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"TriggerEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trigger"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"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."}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"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"}}},"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, this includes both success and error results. This number could change as recordings are being discovered and processed."},"resultCount":{"type":"integer","format":"int32","description":"Current number of results available, this includes both success and error results."},"errorCount":{"type":"integer","format":"int32","description":"Current number of error results."},"status":{"type":"string","description":"Current status of the job. This could be either IN_PROGRESS or COMPLETED. A job is considered completed when all the submitted requests have been processed and fulfilled.","enum":["InProgress","Completed"]},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}}}},"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"}}}},"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"]},"evaluationSettings":{"description":"Settings for evaluations associated with this form","$ref":"#/definitions/EvaluationSettings"},"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"},"revisionCreatedDate":{"type":"string","format":"date-time","description":"Date of when evaluation revision is created. Null if there is no revision. 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","INTERNAL_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"},"surveyType":{"type":"string","description":"Type of the survey","enum":["Web","Voice"]},"missingRequiredAnswer":{"type":"boolean","description":"True if any of the required questions for the survey form have not been answered. Null if survey is not finished."},"flow":{"description":"An Architect flow that executed in order to collect the answers for this survey.","$ref":"#/definitions/AddressableEntityRef"},"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","mediaType","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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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,Pause","readOnly":true,"enum":["Hold","SecurePause","FlowOrQueue","Pause"]},"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","DatePicker","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/Image"}}}},"EmailAttachment":{"type":"object","properties":{"name":{"type":"string"},"contentPath":{"type":"string"},"contentType":{"type":"string"},"attachmentId":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"GenericTemplate":{"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."},"components":{"type":"array","description":"List of button components offered with this message content.","items":{"$ref":"#/definitions/RecordingButtonComponent"}},"actions":{"description":"Actions to be taken.","$ref":"#/definitions/RecordingContentActions"}}},"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"}}},"RecordingAttachment":{"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.","enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment."},"mime":{"type":"string","description":"Attachment mime type."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"fileName":{"type":"string","description":"Suggested file name for attachment."}}},"RecordingButtonComponent":{"type":"object","properties":{"title":{"type":"string"},"actions":{"$ref":"#/definitions/RecordingContentActions"},"isSelected":{"type":"boolean"}},"description":"Structured template button object."},"RecordingContentActions":{"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 sent back in reply when the item is selected."}},"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously."},"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"]}}},"RecordingNotificationTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"language":{"type":"string","description":"Template language."},"header":{"description":"The template header.","$ref":"#/definitions/RecordingTemplateHeader"},"body":{"description":"The template body.","$ref":"#/definitions/RecordingTemplateBody"},"buttons":{"type":"array","description":"Template buttons","items":{"$ref":"#/definitions/RecordingTemplateButton"}},"footer":{"description":"The template footer.","$ref":"#/definitions/RecordingTemplateFooter"}}},"RecordingTemplateBody":{"type":"object","properties":{"text":{"type":"string","description":"Template parameters for placeholders in template."}}},"RecordingTemplateButton":{"type":"object","properties":{"type":{"type":"string","description":"Specifies the type of the button.","enum":["QuickReply","PhoneNumber","Url"]},"text":{"type":"string","description":"Button text message."},"index":{"type":"integer","format":"int64","description":"Index of the button in the list."},"phoneNumber":{"type":"string","description":"Button phone number."},"url":{"type":"string","description":"Button URL link."},"isSelected":{"type":"boolean","description":"Indicates if the button is selected by end customer."}}},"RecordingTemplateFooter":{"type":"object","properties":{"text":{"type":"string","description":"Footer text."}}},"RecordingTemplateHeader":{"type":"object","properties":{"type":{"type":"string","description":"Template header type.","enum":["Text","Media"]},"text":{"type":"string","description":"Header text."},"media":{"description":"Media template header image.","$ref":"#/definitions/RecordingAttachment"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"recordingPlaybackUrlTtl":{"type":"integer","format":"int32","description":"The duration in minutes for which the generated URL for recording playback remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes."},"recordingBatchDownloadUrlTtl":{"type":"integer","format":"int32","description":"The duration in minutes for which the generated URL for recording batch download remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes."}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}}},"Button":{"type":"object","properties":{}},"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"},"MessageFooter":{"type":"object","properties":{}},"MessageHeader":{"type":"object","properties":{}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"]},"type":{"type":"string","description":"Response text type.","enum":["body","subject"]}},"description":"Contains information about the text associated with a response."},"WhatsAppDefinition":{"type":"object","required":["language","name"],"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."},"pageNumber":{"type":"integer","format":"int32","description":"Page Number"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"cannedResponseLibraries":{"description":"Canned response library IDs and mode with which they are associated with the queue","$ref":"#/definitions/CannedResponseLibraries"},"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":{"description":"The default email address to use for outbound email from this queue.","$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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"cannedResponseLibraries":{"description":"Canned response library IDs and mode with which they are associated with the queue","$ref":"#/definitions/CannedResponseLibraries"},"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":{"description":"The default email address to use for outbound email from this queue.","$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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"cannedResponseLibraries":{"description":"Canned response library IDs and mode with which they are associated with the queue","$ref":"#/definitions/CannedResponseLibraries"},"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":{"description":"The default email address to use for outbound email from this queue.","$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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"label":{"description":"Current label on in-queue conversation","$ref":"#/definitions/UtilizationLabel"},"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., \"\"."},"labelId":{"type":"string","description":"Label requirement for the conversation. To remove the label requirement (setting it to System Default Label), 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}}},"GraphApiSettings":{"type":"object","properties":{"integration":{"description":"The Graph API server integration to use for emails.","$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","description":"Graph API Server Status","readOnly":true,"enum":["Active","Error","Inactive","IntegrationDeleted","Unknown"]},"errorInfo":{"description":"Additional Graph API Server error information","readOnly":true,"$ref":"#/definitions/EmailErrorInfo"}}},"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"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"]}},"worktypeId":{"type":"string"},"virtualAgentEnabled":{"type":"boolean"},"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"},"virtualAgentEnabled":{"type":"boolean"},"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"},"description":{"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","whatsapp","webmessaging","instagram","open","apple"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"AgentDirectRoutingBackupSettings":{"type":"object","properties":{"queueId":{"type":"string","description":"ID of queue to be used as backup. If queueId and userId are both specified, queue behaves as secondary backup."},"userId":{"type":"string","description":"ID of user to be used as backup. If queueId and userId are both specified, user behaves as primary backup."},"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]."},"backedUpUsers":{"type":"array","description":"Set of users that this user is a backup for.","readOnly":true,"uniqueItems":true,"items":{"type":"string"}}}},"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"},"description":{"type":"string","description":"The wrap-up code description."},"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."},"dateHire":{"type":"string","description":"The user's hire date. Format in JSON will be YYYY-MM-DD."}},"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."},"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"]}}}},"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"}}}},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"topicLinksJob":{"$ref":"#/definitions/AddressableEntityRef"},"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"}}}},"DeleteProgramResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"topicLinksJob":{"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramsMappingsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ProgramMappings"}},"pageSize":{"type":"integer","format":"int32"},"nextUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AlertablePresences":{"type":"object","required":["alertablePresences"],"properties":{"alertablePresences":{"type":"array","description":"The list of alertable system presences.","items":{"type":"string","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]}}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SitesSearchResponse":{"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/Site"}}}},"SiteSearchCriteria":{"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/SiteSearchCriteria"}},"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","CONTAINS"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}}}},"SiteSearchRequest":{"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/SiteSearchCriteria"}}}},"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}},"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}}},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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":"Whether or not the job was a dry run"},"acceleratorId":{"type":"string","description":"Accelerator associated with the job","readOnly":true},"dateSubmitted":{"type":"string","format":"date-time","description":"Date and time on which job was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"submittedBy":{"description":"User who submitted the job","readOnly":true,"$ref":"#/definitions/UserReference"},"status":{"type":"string","description":"Job status","readOnly":true,"enum":["Created","Queued","Running","Complete","InternalError","Incomplete","Failed","RollbackFailed","RollbackComplete"]},"errorInfo":{"description":"Information about errors, if any","readOnly":true,"$ref":"#/definitions/ErrorInfo"},"results":{"type":"string","description":"The output results of the terraform job","readOnly":true},"rollbackResults":{"type":"string","description":"The results of rolling back the job if there were errors. Not returned if job was successful.","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","Open","Instagram","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","GenesysDigitalBotFlow","GenesysVoiceSurveyFlow"]},"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},"includeBadge":{"type":"boolean","description":"includeBadge","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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChatFavorite":{"type":"object","required":["externalId","id"],"properties":{"id":{"type":"string","description":"The guid id of the favorite"},"externalId":{"type":"string","description":"The external id of the favorite"}}},"ChatItem":{"type":"object","required":["chatType","open"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"open":{"type":"boolean","description":"If the chat is open"},"favorite":{"description":"The favorite entity for the chat, only appears if the chat is favorited","$ref":"#/definitions/ChatFavorite"},"images":{"type":"array","description":"Avatar images for the chat","items":{"$ref":"#/definitions/Image"}},"dateLastMessage":{"type":"string","format":"date-time","description":"The date of the last message. 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 chat was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"user":{"description":"The other 1on1 user","$ref":"#/definitions/ChatUserRef"},"room":{"description":"The room of the chat","$ref":"#/definitions/Room"},"chatType":{"type":"string","description":"The type of chat","enum":["adhoc","acd","group","oneOnOne","supervisorAssistance"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatItemCursorListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChatItem"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"ChatPresence":{"type":"object","properties":{"source":{"type":"string"},"organizationPresence":{"$ref":"#/definitions/OrganizationPresence"},"systemPresence":{"type":"string","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]},"message":{"type":"string"},"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"},"outOfOffice":{"$ref":"#/definitions/OutOfOffice"}}},"ChatUserRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"jid":{"type":"string"},"inactive":{"type":"boolean"},"integrations":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"presence":{"$ref":"#/definitions/ChatPresence"}}},"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/Image"}},"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"},"workPlanBidRanks":{"description":"The WFM work plan bid rank settings for the user","readOnly":true,"$ref":"#/definitions/WorkPlanBidRanks"},"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"}},"autoAnswerSettings":{"description":"Auto answer settings for this user","readOnly":true,"$ref":"#/definitions/AutoAnswerSettings"},"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/Image"}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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},"transcription":{"type":"string","description":"The transcription of the voicemail's audio","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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"}}}},"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."}}},"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}}},"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","Export"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","DECISIONTABLE","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","WORKTYPE"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","DECISIONTABLE","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","WORKTYPE"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"]}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"virtualAgentEnabled":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}}},"GrammarFileUploadRequest":{"type":"object","properties":{"fileType":{"type":"string","enum":["gram","grxml"]}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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}}},"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}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"notifications":{"description":"The notification settings for messenger apps","$ref":"#/definitions/NotificationsSettings"}},"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 are 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"},"sessionPersistenceType":{"type":"string","description":"The session persistence type for messenger","enum":["AcrossSubdomains","DomainOrSubdomainOnly"]}},"description":"Settings concerning messenger"},"MessengerStyles":{"type":"object","properties":{"primaryColor":{"type":"string","example":"#a7017c","description":"The primary color of messenger in hexadecimal"}}},"NotificationsSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The toggle to enable or disable notifications"}},"description":"Notification settings that handles messenger notifications"},"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"}}},"SupportCenterLabelFilter":{"type":"object","properties":{"labels":{"type":"array","description":"Labels to filter by.","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"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"}},"labelFilter":{"description":"Document label filter. If set, only documents having at least one of the specified labels will be returned by knowledge document query operations.","$ref":"#/definitions/SupportCenterLabelFilter"},"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"},"WebDeploymentConfigurationVersionEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"total":{"type":"integer","format":"int64"}}},"WebDeploymentHeadlessMode":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether or not Headless Mode is enabled"}}},"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/WebDeploymentFlowEntityRef"},"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"}}},"WebDeploymentFlowEntityRef":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Flow ID"},"name":{"type":"string","description":"The Flow name"},"selfUri":{"type":"string","format":"uri"},"flowDescription":{"type":"string","description":"The flow description for the webdeployment"},"publishVersion":{"description":"The published config version for the associated deployment","$ref":"#/definitions/FlowVersion"}}},"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/WebDeploymentFlowEntityRef"},"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":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExpandableWebDeployment"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"total":{"type":"integer","format":"int64"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"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}}},"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"},"AddConversationResponse":{"type":"object","properties":{"conversation":{"description":"The conversation reference","readOnly":true,"$ref":"#/definitions/ConversationReference"},"appointment":{"description":"The appointment reference","readOnly":true,"$ref":"#/definitions/CoachingAppointmentReference"}}},"AddConversationRequest":{"type":"object","required":["conversationId"],"properties":{"conversationId":{"type":"string","description":"The id of the conversation to add"}},"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"}}},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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","Native"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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 (deprecated), AssessedContent (deprecated), Assessment (deprecated), Coaching, External, Native"}}},"CelebrationStateParam":{"type":"object","properties":{"state":{"type":"string","description":"The state of the celebration","enum":["Displayed"]}}},"Celebration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"recipient":{"description":"The Recipient of the celebration","$ref":"#/definitions/UserReference"},"createdBy":{"description":"The creator of the celebration","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The date the celebration was created on. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The Celebration Type","enum":["Recognition"]},"title":{"type":"string","description":"The Celebration title"},"note":{"type":"string","description":"The Celebration note"},"sourceEntity":{"description":"The celebration's source entity","$ref":"#/definitions/SourceEntity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GetCelebrationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Celebration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SourceEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of the source entity","enum":["ThankYou","Congratulations","HighPerformance","CompanyValues"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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 (deprecated), AssessedContent (deprecated), Assessment (deprecated), External, Native"}}},"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","Native"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"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. Informational, AssessedContent and Assessment are deprecated","enum":["Informational","AssessedContent","Assessment","External","Native"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"name":{"type":"string","description":"The name of this SCO in the course manifest"},"successStatus":{"type":"string","description":"The success status of this SCO","enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of this SCO","enum":["Completed","Incomplete","NotAttempted","Unknown"]},"percentageScore":{"type":"number","format":"float","description":"Percentage Score"},"children":{"type":"array","description":"Child items belonging to this SCO in the course manifest","items":{"$ref":"#/definitions/LearningModulePreviewUpdateScoStructure"}}},"description":"Learning module preview update SCO structure"},"LearningModulePreviewUpdateStep":{"type":"object","properties":{"id":{"type":"string","description":"The id of the step"},"successStatus":{"type":"string","description":"The success status of the step","enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of the step","enum":["Completed","Incomplete","NotAttempted","Unknown"]},"completionPercentage":{"type":"number","format":"float","description":"The completion percentage of the step"},"percentageScore":{"type":"number","format":"float","description":"Percentage Score"},"structure":{"type":"array","description":"The structure for any SCO associated with this step","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"},"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"},"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","Native"]},"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"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"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"},"Recognition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"recipient":{"description":"The recipient of the recognition","$ref":"#/definitions/UserReference"},"createdBy":{"description":"The creator of the recognition","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The creation date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The type of recognition","enum":["ThankYou","Congratulations","HighPerformance","CompanyValues"]},"title":{"type":"string","description":"The recognition title"},"note":{"type":"string","description":"The recognition note"},"contextType":{"type":"string","description":"The context type (optional)","enum":["Interaction","Insights","Development","Scorecard"]},"contextId":{"type":"string","description":"The context id (optional)"},"dateDisplayed":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The displayed date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateAcknowledged":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The acknowledged date. 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}}},"RecognitionBase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"recipient":{"description":"The recipient of the recognition","$ref":"#/definitions/UserReference"},"createdBy":{"description":"The creator of the recognition","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The creation date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The type of recognition","enum":["ThankYou","Congratulations","HighPerformance","CompanyValues"]},"title":{"type":"string","description":"The recognition title"},"note":{"type":"string","description":"The recognition note"},"contextType":{"type":"string","description":"The context type (optional)","enum":["Interaction","Insights","Development","Scorecard"]},"contextId":{"type":"string","description":"The context id (optional)"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateRecognition":{"type":"object","required":["recipientId","type"],"properties":{"recipientId":{"type":"string","description":"The recipient of the recognition"},"type":{"type":"string","description":"The type of the recognition","enum":["ThankYou","Congratulations","HighPerformance","CompanyValues"]},"title":{"type":"string","description":"The title of the recognition. Max length of 100 characters (optional)"},"note":{"type":"string","description":"The note of the recognition. Max length of 800 characters (optional)"},"contextType":{"type":"string","description":"The context type (optional)","enum":["Interaction","Insights","Development","Scorecard"]},"contextId":{"type":"string","description":"The context id (optional)"}}},"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}}},"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"}}}},"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"}}},"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","Workitem"]},"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","Workitem"]},"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"}}},"ActivityCodeReference":{"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}}},"BuActivitySettingsResponse":{"type":"object","properties":{"defaultActivityCode":{"description":"Default Activity Code settings","$ref":"#/definitions/ActivityCodeReference"}}},"BuNotificationSettingsResponse":{"type":"object","properties":{"scheduling":{"description":"Schedule notification settings","$ref":"#/definitions/BuScheduleNotificationsSettingsResponse"}}},"BuScheduleNotificationsCategorySettings":{"type":"object","required":["activityCategory","earlyReminderEnabled","onTimeReminderEnabled"],"properties":{"activityCategory":{"type":"string","description":"The activity category","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"earlyReminderEnabled":{"type":"boolean","description":"Indicates if agents should receive early schedule reminder notifications."},"onTimeReminderEnabled":{"type":"boolean","description":"Indicates if agents should receive out of adherence notifications."}}},"BuScheduleNotificationsSettingsResponse":{"type":"object","required":["activityCategorySettings","earlyReminderMinutes"],"properties":{"earlyReminderMinutes":{"type":"integer","format":"int32","description":"The number of minutes prior to the scheduled event to display an early reminder notification"},"activityCategorySettings":{"type":"array","description":"List of activity category notification settings","items":{"$ref":"#/definitions/BuScheduleNotificationsCategorySettings"}}}},"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"]}}},"BuActivitySettingsRequest":{"type":"object","properties":{"defaultActivityCodeId":{"type":"string","description":"The ID of the activity code. This is the activity code that will be used by default for agent development activities added to the schedule"}}},"BuNotificationSettingsRequest":{"type":"object","properties":{"scheduling":{"description":"Schedule notification settings","$ref":"#/definitions/BuScheduleNotificationsSettingsRequest"}}},"BuScheduleNotificationsSettingsRequest":{"type":"object","properties":{"earlyReminderMinutes":{"type":"integer","format":"int32","description":"The number of minutes prior to the scheduled event to display an early reminder notification"},"activityCategorySettings":{"type":"array","description":"List of activity category notification settings","items":{"$ref":"#/definitions/BuScheduleNotificationsCategorySettings"}}}},"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"},"nextUri":{"type":"string","format":"uri","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"},"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"}}},"MonthlyPlanningPeriodSettings":{"type":"object","required":["startDate"],"properties":{"startDate":{"type":"string","format":"date","description":"Start date of the monthly planning period in yyyy-MM-dd format. The date must represent the first day of the given month. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"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"}}},"ValueWrapperMonthlyPlanningPeriodSettings":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/MonthlyPlanningPeriodSettings"}}},"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 initiating shift 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"}}}},"AgentWorkPlans":{"type":"object","required":["user","workPlanLookupKeysPerWeek"],"properties":{"user":{"description":"The user (agent) for whom the work plans were requested","$ref":"#/definitions/UserReference"},"workPlanLookupKeysPerWeek":{"type":"array","description":"The list of weekly work plan lookup keys. Keys to be searched under workPlanLookup property at top level of result","items":{"type":"integer","format":"int32"}}}},"AgentsWorkPlansResponse":{"type":"object","properties":{"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"},"result":{"description":"The result of agent(s) work plans query","$ref":"#/definitions/MuAgentsWorkPlansResult"}}},"MuAgentsWorkPlansResult":{"type":"object","required":["referenceStartWeekDate","workPlanLookup"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentWorkPlans"}},"referenceStartWeekDate":{"type":"string","format":"date","description":"The reference date in yyyy-MM-dd format rolled back to nearest BU start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"workPlanLookup":{"type":"object","description":"Map containing lookup values for agent work plans. The integer keys serves as lookup keys for effective work plan from workPlanLookupKeysPerWeek property","additionalProperties":{"$ref":"#/definitions/WorkPlanReference"}}}},"GetAgentsWorkPlansRequest":{"type":"object","required":["agentIds","startDate","weekCount"],"properties":{"agentIds":{"type":"array","description":"The list of agent IDs","items":{"type":"string"}},"startDate":{"type":"string","format":"date","description":"The start of a date in yyyy-MM-dd format. Response contains values rolled back to nearest BU start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks to query"}}},"UpdateMuAgentWorkPlanFailureResponse":{"type":"object","required":["failure","user"],"properties":{"user":{"description":"The user for whom the work plan update has failed","$ref":"#/definitions/UserReference"},"failure":{"type":"string","description":"The work plan update failure reason","enum":["AgentNotInManagementUnit","OverlappingOverride","OverrideNotFound","TooManyOverrides","WorkPlanNotFound"]},"notFoundWorkPlanId":{"type":"string","description":"The id of the work plan that has not been found"}}},"UpdateMuAgentWorkPlansBatchResponse":{"type":"object","required":["failures"],"properties":{"failures":{"type":"array","description":"The work plan update failures","items":{"$ref":"#/definitions/UpdateMuAgentWorkPlanFailureResponse"}}}},"UpdateMuAgentWorkPlanRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The agent id for whom the work plan is updated"},"workPlanId":{"description":"The current work plan ID for the agent","$ref":"#/definitions/ValueWrapperString"},"workPlanOverrides":{"description":"The list of work plan overrides for the agent","$ref":"#/definitions/WorkPlanOverrideListWrapperWorkPlanOverrideRequest"}}},"UpdateMuAgentWorkPlansBatchRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UpdateMuAgentWorkPlanRequest"}}}},"ValueWrapperString":{"type":"object","properties":{"value":{"type":"string","description":"The value for the associated field"}}},"WorkPlanOverrideListWrapperWorkPlanOverrideRequest":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/WorkPlanOverrideRequest"}},"deleteAll":{"type":"boolean","description":"if true, should delete all existing overrides for the agent and update the given overrides"}}},"WorkPlanOverrideRequest":{"type":"object","required":["startDate"],"properties":{"action":{"type":"string","description":"The action to perform on work plan override, defaults to add","enum":["Add","Update","Delete"]},"startDate":{"type":"string","format":"date","description":"The start date in yyyy-MM-dd format for the updated work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The week count of the updated work plan, required if action is Add or Update"},"workPlanId":{"type":"string","description":"The updated work plan id"}}},"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","Workitem"]},"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 with the initiating shift in the given week"}}},"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}}},"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"}}},"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}}},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","OverlapsRestrictedActivityCode"]},"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","OverlapsRestrictedActivityCode"]},"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","OverlapsRestrictedActivityCode"]}},"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}}},"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}}},"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}}},"CopyWorkPlanRotationRequest":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name to apply to the new copy of the work plan rotation"}}},"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"}}},"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"}}}},"WorkPlanRotationListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanRotationResponse"}}}},"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"}}},"ActivityPlanJobException":{"type":"object","required":["exceptionType","occurrences"],"properties":{"exceptionType":{"type":"string","description":"The type of error","enum":["UnscheduledAttendees","SessionsNotDeleted"]},"occurrences":{"type":"array","description":"The occurrences in which this error occurred","items":{"$ref":"#/definitions/ActivityPlanOccurrenceReference"}}}},"ActivityPlanJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActivityPlanJobResponse"}}}},"ActivityPlanJobResponse":{"type":"object","required":["activityPlan","exceptions","status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"activityPlan":{"description":"The activity plan associated with this job","$ref":"#/definitions/ActivityPlanReference"},"status":{"type":"string","description":"The status of the job","enum":["Processing","Complete","Error"]},"exceptions":{"type":"array","description":"The list of exceptions that occurred while running this activity plan job. These are exceptions that affect individual occurrences but didn't prevent the job from completing","items":{"$ref":"#/definitions/ActivityPlanJobException"}},"error":{"description":"Error details if status == 'Error'. These are errors that caused the job to fail to complete","$ref":"#/definitions/ErrorBody"},"occurrence":{"description":"The occurrence associated with this job if type == 'DeleteOccurrence'","$ref":"#/definitions/ActivityPlanOccurrenceReference"},"type":{"type":"string","description":"The type of the job","enum":["RunPlan","DeleteOccurrence"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActivityPlanOccurrenceReference":{"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}}},"ActivityPlanReference":{"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}}},"ActivityPlanListItem":{"type":"object","required":["activityCode","createdBy","createdDate","description","modifiedBy","modifiedDate","name","optimizationObjective","state","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the activity plan"},"managementUnits":{"type":"array","description":"The management units to which this activity plan applies. Empty list or null means this activity plan applies to all management units in the business unit","items":{"$ref":"#/definitions/ManagementUnitReference"}},"description":{"type":"string","description":"The description of this activity plan"},"activityCode":{"description":"The activity code to which this activity plan applies. Note: It is recommended to load and cache the entire list of activity codes rather than look up individual codes","$ref":"#/definitions/ActivityCodeReference"},"type":{"type":"string","description":"The type of the activity plan","enum":["Individual","Group"]},"optimizationObjective":{"type":"string","description":"The optimization objective of this activity plan","enum":["FavorServiceGoals","FavorSchedulingAll"]},"recurrenceSettings":{"description":"Recurrence settings for this activity plan","$ref":"#/definitions/RecurrenceSettings"},"state":{"type":"string","description":"The state of this activity plan","enum":["Active","Inactive"]},"lastRunDate":{"type":"string","format":"date-time","description":"The date the activity plan was last run, in ISO-8601 format"},"lastRunBy":{"description":"The last user to run this activity plan","$ref":"#/definitions/UserReference"},"createdDate":{"type":"string","format":"date-time","description":"The date the activity plan was created, in ISO-8601 format"},"createdBy":{"description":"The user who created this activity plan","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the activity plan was modified, in ISO-8601 format"},"modifiedBy":{"description":"The last user to modify this activity plan","$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActivityPlanListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActivityPlanListItem"}}}},"RecurrenceEndSettings":{"type":"object","properties":{"lastDate":{"type":"string","format":"date-time","description":"The end date of the recurrence for the activity plan, in ISO-8601 format. Only one of lastDate or noEndDate may be set"},"noEndDate":{"type":"boolean","description":"Whether this activity plan should continue indefinitely. If set to true, lastDate must not be set"}}},"RecurrencePeriod":{"type":"object","required":["granularity","magnitude"],"properties":{"magnitude":{"type":"integer","format":"int32","description":"The period of the activity plan in granularity units"},"granularity":{"type":"string","description":"The granularity unit to interpret the period of this activity plan","enum":["Days","Weeks"]}}},"RecurrenceSettings":{"type":"object","required":["endAfter","minimumTimeBetweenOccurrences","recurrencePeriod"],"properties":{"recurrencePeriod":{"description":"The recurrence period of the activity plan","$ref":"#/definitions/RecurrencePeriod"},"minimumTimeBetweenOccurrences":{"description":"Constraint indicating the minimum time in hours between recurrences of the activity plan","$ref":"#/definitions/RecurrencePeriod"},"endAfter":{"description":"Settings controlling when to end the recurrence for the activity plan","$ref":"#/definitions/RecurrenceEndSettings"}}},"ActivityPlanAbandonRateImpactOverride":{"type":"object","required":["increaseByPercent"],"properties":{"increaseByPercent":{"type":"number","format":"double","description":"Allowed abandon rate increase percent, from 0.0 to 100.0"}}},"ActivityPlanAsaImpactOverride":{"type":"object","required":["increaseByPercent"],"properties":{"increaseByPercent":{"type":"number","format":"double","description":"Allowed average speed of answer increase percent, from 0.0 to 100.0"}}},"ActivityPlanResponse":{"type":"object","required":["activityCode","countsAsPaidTime","createdBy","createdDate","description","facilitated","initialSchedulePeriod","lengthMinutes","modifiedBy","modifiedDate","name","optimizationObjective","state","transitionTimeMinutes","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the activity plan"},"managementUnits":{"type":"array","description":"The management units to which this activity plan applies. Empty list or null means this activity plan applies to the entire business unit","items":{"$ref":"#/definitions/ManagementUnitReference"}},"description":{"type":"string","description":"The description of this activity plan"},"activityCode":{"description":"The activity code associated with this activity plan. It is recommended to load and cache the entire list of activity codes rather than look up individual codes","$ref":"#/definitions/ActivityCodeReference"},"type":{"type":"string","description":"The type of the activity plan","enum":["Individual","Group"]},"initialSchedulePeriod":{"description":"The initial schedule period of the activity plan","$ref":"#/definitions/SchedulingPeriod"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the activity in minutes"},"groupSettings":{"description":"Group settings for this activity plan","$ref":"#/definitions/GroupSettings"},"recurrenceSettings":{"description":"Recurrence settings for this activity plan","$ref":"#/definitions/RecurrenceSettings"},"attendeesSearchRule":{"description":"Attendee search rule for this activity plan","$ref":"#/definitions/UserSearchRule"},"facilitated":{"type":"boolean","description":"Whether the sessions created by this activity plan should be facilitated"},"facilitatorsSearchRule":{"description":"Facilitator search rule for this activity plan","$ref":"#/definitions/UserSearchRule"},"transitionTimeMinutes":{"type":"integer","format":"int32","description":"Transition time in minutes between facilitated sessions"},"serviceGoalImpactOverrides":{"description":"Allowable service goal impact override settings for this activity plan","$ref":"#/definitions/ActivityPlanServiceGoalImpactOverrides"},"optimizationObjective":{"type":"string","description":"The optimization objective of this activity plan","enum":["FavorServiceGoals","FavorSchedulingAll"]},"fixedAvailability":{"type":"array","description":"Fixed availability configuration for this activity plan","items":{"$ref":"#/definitions/FixedAvailability"}},"state":{"type":"string","description":"The state of this activity plan","enum":["Active","Inactive"]},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity should count as paid time"},"createdDate":{"type":"string","format":"date-time","description":"The date the activity plan was created, in ISO-8601 format"},"createdBy":{"description":"The user who created this activity plan","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the activity plan was modified, in ISO-8601 format"},"modifiedBy":{"description":"The last user to modify this activity plan","$ref":"#/definitions/UserReference"},"lastRunDate":{"type":"string","format":"date-time","description":"The date the activity plan was last run, in ISO-8601 format"},"lastRunBy":{"description":"The last user to run this activity plan","$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActivityPlanServiceGoalImpactOverrides":{"type":"object","required":["abandonRate","averageSpeedOfAnswer","serviceLevel"],"properties":{"abandonRate":{"description":"Abandon rate service goal override for the associated activity plan","$ref":"#/definitions/ActivityPlanAbandonRateImpactOverride"},"serviceLevel":{"description":"Service level goal override for the associated activity plan","$ref":"#/definitions/ActivityPlanServiceLevelImpactOverride"},"averageSpeedOfAnswer":{"description":"Average speed of answer service goal override for the associated activity plan","$ref":"#/definitions/ActivityPlanAsaImpactOverride"}}},"ActivityPlanServiceLevelImpactOverride":{"type":"object","required":["decreaseByPercent"],"properties":{"decreaseByPercent":{"type":"number","format":"double","description":"Allowed service level decrease percent, from 0.0 to 100.0"}}},"AvailabilityRange":{"type":"object","required":["earliestStartMinutesFromMidnight","latestEndMinutesFromMidnight"],"properties":{"earliestStartMinutesFromMidnight":{"type":"integer","format":"int32","description":"The earliest time of day the activity can be scheduled to begin, in minutes from midnight in the configured time zone of the business unit"},"latestEndMinutesFromMidnight":{"type":"integer","format":"int32","description":"The latest time of day the activity can be scheduled to end, in minutes from midnight in the configured time zone of the business unit"}}},"FixedAvailability":{"type":"object","properties":{"availabilityRange":{"description":"The range of time of day the activity can be scheduled","$ref":"#/definitions/AvailabilityRange"},"dateRange":{"description":"The range of date for which the activity plan could be scheduled","$ref":"#/definitions/RequiredLocalDateRange"},"daysOfWeek":{"type":"array","description":"The days of week available for scheduling. Empty list or null means daysOfWeek is not considered","items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}},"GroupSettings":{"type":"object","properties":{"minimumGroupSize":{"type":"integer","format":"int32","description":"The minimum size of a group for a session"},"maximumGroupSize":{"type":"integer","format":"int32","description":"The maximum size of a group for a session"},"maximumTotalSessions":{"type":"integer","format":"int32","description":"The maximum total number of sessions"},"maximumConcurrentSessions":{"type":"integer","format":"int32","description":"The maximum number of sessions that can be scheduled concurrently"}}},"RequiredLocalDateRange":{"type":"object","required":["endDate","startDate"],"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"}}},"SchedulingPeriod":{"type":"object","required":["earliestStartDate","latestEndDate"],"properties":{"earliestStartDate":{"type":"string","format":"date","description":"The earliest date the associated activity plan can begin, in YYYY-MM-DD format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"latestEndDate":{"type":"string","format":"date","description":"The latest date the associated activity plan can end, in YYYY-MM-DD format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"UserSearchRule":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","description":"The parts of this rule; the results of these are ANDed together.","items":{"$ref":"#/definitions/UserSearchRulePart"}}}},"UserSearchRulePart":{"type":"object","required":["ids","operation","selector"],"properties":{"operation":{"type":"string","description":"The operation for this part","enum":["Include","Exclude"]},"selector":{"type":"string","description":"The type of item being selected by this part","enum":["AcdSkill","User","Group","Queue","Division","ManagementUnit"]},"ids":{"type":"array","description":"The ids for the selector; the results of these are ORed together","uniqueItems":true,"items":{"type":"string"}}}},"CreateActivityPlanRequest":{"type":"object","required":["activityCodeId","countsAsPaidTime","initialSchedulePeriod","lengthMinutes","name","optimizationObjective","state","transitionTimeMinutes","type"],"properties":{"name":{"type":"string","description":"The name of the activity plan"},"managementUnitIds":{"type":"array","description":"The management units to which this activity plan applies. Empty list or null means this activity plan applies to the entire business unit","items":{"type":"string"}},"description":{"type":"string","description":"The description of the activity plan"},"activityCodeId":{"type":"string","description":"The activity code associated with the activity plan"},"type":{"type":"string","description":"The type of the activity plan","enum":["Individual","Group"]},"lengthMinutes":{"type":"integer","format":"int32","description":"The length in minutes of the activity plan"},"initialSchedulePeriod":{"description":"The initial scheduling period for the activity plan","$ref":"#/definitions/SchedulingPeriod"},"groupSettings":{"description":"Group settings for the activity plan","$ref":"#/definitions/GroupSettings"},"recurrenceSettings":{"description":"Settings controlling recurrence for the activity plan. If not set the activity plan will only occur once","$ref":"#/definitions/RecurrenceSettings"},"attendeesSearchRule":{"description":"Attendee search rule for this activity plan","$ref":"#/definitions/UserSearchRule"},"facilitated":{"type":"boolean","description":"Whether the sessions created by this activity plan should be facilitated"},"facilitatorsSearchRule":{"description":"Facilitator search rule for this activity plan","$ref":"#/definitions/UserSearchRule"},"transitionTimeMinutes":{"type":"integer","format":"int32","description":"Transition time in minutes between facilitated sessions"},"serviceGoalImpactOverrides":{"description":"Allowable service goal impact override settings for this activity plan. If not set the business unit setting will be used","$ref":"#/definitions/ActivityPlanServiceGoalImpactOverrides"},"optimizationObjective":{"type":"string","description":"The optimization objective of this activity plan","enum":["FavorServiceGoals","FavorSchedulingAll"]},"state":{"type":"string","description":"The state of this activity plan","enum":["Active","Inactive"]},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity should count as paid time"},"fixedAvailability":{"type":"array","description":"Fixed availability configuration for the activity plan","items":{"$ref":"#/definitions/FixedAvailability"}}}},"ListWrapperFixedAvailability":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/FixedAvailability"}}}},"UpdateActivityPlanRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the activity plan"},"description":{"type":"string","description":"The description of the activity plan"},"groupSettings":{"description":"Group settings for the activity plan","$ref":"#/definitions/ValueWrapperGroupSettings"},"attendeesSearchRule":{"description":"Attendee search rule for this activity plan","$ref":"#/definitions/ValueWrapperUserSearchRule"},"facilitatorsSearchRule":{"description":"Facilitator search rule for this activity plan","$ref":"#/definitions/ValueWrapperUserSearchRule"},"transitionTimeMinutes":{"type":"integer","format":"int32","description":"Transition time in minutes between facilitated sessions"},"serviceGoalImpactOverrides":{"description":"Allowable service goal impact override settings for this activity plan","$ref":"#/definitions/ValueWrapperActivityPlanServiceGoalImpactOverrides"},"optimizationObjective":{"type":"string","description":"The optimization objective of this activity plan","enum":["FavorServiceGoals","FavorSchedulingAll"]},"state":{"type":"string","description":"The state of this activity plan","enum":["Active","Inactive"]},"fixedAvailability":{"description":"Fixed availability configuration for the activity plan","$ref":"#/definitions/ListWrapperFixedAvailability"}}},"ValueWrapperActivityPlanServiceGoalImpactOverrides":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/ActivityPlanServiceGoalImpactOverrides"}}},"ValueWrapperGroupSettings":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/GroupSettings"}}},"ValueWrapperUserSearchRule":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/UserSearchRule"}}},"ActivityPlanRunJobResponse":{"type":"object","required":["activityPlan","exceptions","status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"activityPlan":{"description":"The activity plan associated with this job","$ref":"#/definitions/ActivityPlanReference"},"status":{"type":"string","description":"The status of the job","enum":["Processing","Complete","Error"]},"exceptions":{"type":"array","description":"The list of exceptions that occurred while running this activity plan job. These are exceptions that affect individual occurrences but didn't prevent the job from completing","items":{"$ref":"#/definitions/ActivityPlanJobException"}},"error":{"description":"Error details if status == 'Error'. These are errors that caused the job to fail to complete","$ref":"#/definitions/ErrorBody"},"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}}},"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}}},"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"}}},"AdherenceExplanationAsyncResponse":{"type":"object","properties":{"job":{"description":"A reference to the job that was started by the request","$ref":"#/definitions/AdherenceExplanationJobReference"}}},"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"]}}},"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"}}},"ActivityCodeSummary":{"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}}},"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}}},"UserNextActivityReminder":{"type":"object","properties":{}},"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/ActivityCodeSummary"},"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"}}},"AlternativeShiftBuSettingsResponse":{"type":"object","required":["enabledGranularities","metadata","minMinutesBeforeStartTime","retainedActivityCategories"],"properties":{"enabledGranularities":{"type":"array","description":"The granularity at which alternative shifts is allowed. An empty list means Alternative Shifts is disabled","items":{"type":"string","enum":["Daily"]}},"minMinutesBeforeStartTime":{"type":"integer","format":"int32","description":"The minimum number of minutes before the start of a shift that an alternative shift can be automatically approved"},"retainedActivityCategories":{"type":"array","description":"Categories of activities that are required to remain at the same time slot for the alternative shifts offered. An empty list represents no retained activities","items":{"type":"string","enum":["Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable"]}},"metadata":{"description":"Version metadata for this business unit's alternative shift settings","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AlternativeShiftAgentScheduledShift":{"type":"object","required":["activities","dayIndex","lengthMinutes","referenceKey","startDate"],"properties":{"dayIndex":{"type":"integer","format":"int32","description":"The number of days since start of schedule"},"referenceKey":{"type":"string","description":"A key generated for an offer to help facilitate alternative shift trading"},"startDate":{"type":"string","format":"date-time","description":"The start date of this shift in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this shift in minutes"},"activities":{"type":"array","description":"A list of activities in this shift","items":{"$ref":"#/definitions/BuAgentScheduleActivity"}}}},"AlternativeShiftBulkUpdateTradesResponseTemplate":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AlternativeShiftTradeBulkUpdateTemplateItem"}}}},"AlternativeShiftOffersViewResponseTemplate":{"type":"object","required":["agentId","alternativeDays","businessUnitId","jobId","managementUnitId","offerWeekDate","schedule","shifts"],"properties":{"jobId":{"type":"string","description":"The unique identifier of the async list job that created this file"},"businessUnitId":{"type":"string","description":"The unique identifier of the business unit to which the user (agent) belongs at the time the offer is created"},"agentId":{"type":"string","description":"The unique identifier of the agent for whom the offer was made"},"managementUnitId":{"type":"string","description":"The unique identifier of the management unit to which the user (agent) belongs at the time the offer is created"},"schedule":{"description":"The existing schedule information associated with the offer","$ref":"#/definitions/AlternativeShiftScheduleLookup"},"offerWeekDate":{"type":"string","format":"date","description":"The first date of the week for the schedule we are querying in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"shifts":{"type":"array","description":"The shifts the agent is scheduled for at the time the offer is created","items":{"$ref":"#/definitions/AlternativeShiftAgentScheduledShift"}},"alternativeDays":{"type":"array","description":"The offered alternative shift days in this week at the time the offer is created","items":{"$ref":"#/definitions/AlternativeShiftAgentScheduledShift"}}}},"AlternativeShiftScheduleLookup":{"type":"object","required":["id","weekDate"],"properties":{"id":{"type":"string","description":"The unique identifier of the schedule"},"weekDate":{"type":"string","format":"date","description":"The start date for this schedule in yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"AlternativeShiftTradeBulkUpdateTemplateItem":{"type":"object","required":["metadata","state","tradeId"],"properties":{"tradeId":{"type":"string","description":"The ID of this alternative shift trade"},"state":{"type":"string","description":"The current state of this alternative shift trade request","enum":["Canceled","Denied","Expired","Submitted","Approved"]},"failureReason":{"type":"string","description":"The reason the update failed, if applicable","enum":["TransitionNotAllowed","NotAuthorized"]},"adminDateReviewed":{"type":"string","format":"date-time","description":"The timestamp of when the trade request was manually reviewed by an admin in ISO-8601 format"},"adminReviewedBy":{"description":"The admin who manually reviewed this alternative shift trade after system denial","$ref":"#/definitions/UserReference"},"metadata":{"description":"Version metadata for this alternative shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AlternativeShiftTradeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}}}},"AlternativeShiftTradeResponse":{"type":"object","required":["existingShifts","managementUnit","metadata","offeredShifts","schedule","shiftOfferJobId","state","user","violations"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"shiftOfferJobId":{"type":"string","description":"The job ID of the alternative shift offer listing, from which the trade was chosen"},"existingShifts":{"type":"array","description":"The existing shifts from the offer, may be empty","items":{"$ref":"#/definitions/AlternativeShiftAgentScheduledShift"}},"offeredShifts":{"type":"array","description":"The offered shifts from the offer, may be empty","items":{"$ref":"#/definitions/AlternativeShiftAgentScheduledShift"}},"schedule":{"description":"The existing schedule information associated with the trade","$ref":"#/definitions/AlternativeShiftScheduleLookup"},"managementUnit":{"description":"The management unit of this alternative shift trade request","$ref":"#/definitions/ManagementUnitReference"},"user":{"description":"The user who submitted the trade request","$ref":"#/definitions/UserReference"},"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"},"expirationDate":{"type":"string","format":"date-time","description":"The date when the trade will expire in ISO-8601 format. The trade cannot be approved after expiration"},"state":{"type":"string","description":"The state of this alternative shift trade","enum":["Canceled","Denied","Expired","Submitted","Approved"]},"processingStatus":{"type":"string","description":"The processing status of this alternative shift trade","enum":["Error","WaitingForScheduleUpdate","ScheduleUpdating","ScheduleUpdated","WaitingForReview","Reviewing"]},"systemDateReviewed":{"type":"string","format":"date-time","description":"The timestamp of when the trade request was reviewed by the system in ISO-8601 format"},"adminDateReviewed":{"type":"string","format":"date-time","description":"The timestamp of when the trade request was reviewed by an admin in ISO-8601 format"},"adminReviewedBy":{"description":"The admin who reviewed this alternative shift trade after system denial","$ref":"#/definitions/UserReference"},"violations":{"type":"array","description":"A list of trade match violations","items":{"type":"string","enum":["ServiceGoalsNotMet"]}},"metadata":{"description":"Version metadata for this alternative shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlternativeShiftTradesViewResponseTemplate":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}}}},"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"]}}},"BuAlternativeShiftJobResponse":{"type":"object","required":["status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the alternative shift job","enum":["Processing","Complete","Error"]},"type":{"type":"string","description":"The type of job","enum":["ListOffers","SearchOffers","ListUserTrades","SearchTrades","BulkUpdateTrades"]},"downloadUrl":{"type":"string","description":"The URL where completed results are available, only set if status == 'Complete'"},"error":{"description":"Any error information, only set if the status == 'Error'","$ref":"#/definitions/ErrorBody"},"viewOffersResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListOffers' or 'SearchOffers'","$ref":"#/definitions/AlternativeShiftOffersViewResponseTemplate"},"viewTradesResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListUserTrades' or 'SearchTrades'","$ref":"#/definitions/AlternativeShiftTradesViewResponseTemplate"},"bulkUpdateTradesResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'BulkUpdateTrades'","$ref":"#/definitions/AlternativeShiftBulkUpdateTradesResponseTemplate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuListAlternativeShiftTradesResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the request. Null if result returns synchronously","$ref":"#/definitions/BuAlternativeShiftJobResponse"},"result":{"description":"The result of the request. May come via notification. Null if job is populated","$ref":"#/definitions/AlternativeShiftTradeListing"}}},"SearchAlternativeShiftTradesRequest":{"type":"object","properties":{"managementUnitIds":{"type":"array","description":"The list of management unit IDs for this alternative shift trade search. Either managementUnitIds or agentIds is required","items":{"type":"string"}},"agentIds":{"type":"array","description":"The list of agent IDs for this alternative shift trade search. Either managementUnitIds or agentIds is required","items":{"type":"string"}}}},"ListWrapperAlternativeShiftBuSettingsActivityCategory":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string","enum":["Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable"]}}}},"ListWrapperAlternativeShiftBuSettingsGranularity":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string","enum":["Daily"]}}}},"UpdateAlternativeShiftBuSettingsRequest":{"type":"object","required":["metadata"],"properties":{"enabledGranularities":{"description":"The granularity at which alternative shifts is allowed. An empty list as the wrapped value will indicate alternative shifts is disabled","$ref":"#/definitions/ListWrapperAlternativeShiftBuSettingsGranularity"},"minMinutesBeforeStartTime":{"type":"integer","format":"int32","description":"The minimum number of minutes before the start of a shift that an alternative shift can be automatically approved"},"retainedActivityCategories":{"description":"Categories of activities that are required to remain at the same time slot for the alternative shifts offered. An empty list indicates no retained activities","$ref":"#/definitions/ListWrapperAlternativeShiftBuSettingsActivityCategory"},"metadata":{"description":"Version metadata for this business unit's alternative shift settings","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AlternativeShiftAsyncResponse":{"type":"object","required":["job"],"properties":{"job":{"description":"The job related to the async request","$ref":"#/definitions/AlternativeShiftJobReference"}}},"AlternativeShiftJobReference":{"type":"object","required":["status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the alternative shift job","enum":["Processing","Complete","Error"]},"type":{"type":"string","description":"The type of alternative shift asynchronous job","enum":["ListOffers","SearchOffers","ListUserTrades","SearchTrades","BulkUpdateTrades"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlternativeShiftOffersRequest":{"type":"object","required":["queryWeekDate","schedule"],"properties":{"schedule":{"description":"The existing schedule being used to find alternative shift offers","$ref":"#/definitions/AlternativeShiftScheduleLookup"},"queryWeekDate":{"type":"string","format":"date","description":"The start date for the week in this schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"AlternativeShiftJobResponse":{"type":"object","required":["status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the alternative shift job","enum":["Processing","Complete","Error"]},"type":{"type":"string","description":"The type of job","enum":["ListOffers","SearchOffers","ListUserTrades","SearchTrades","BulkUpdateTrades"]},"downloadUrl":{"type":"string","description":"The URL where completed results are available, only set if status == 'Complete'"},"error":{"description":"Any error information, only set if the status == 'Error'","$ref":"#/definitions/ErrorBody"},"viewOffersResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListOffers' or 'SearchOffers'","$ref":"#/definitions/AlternativeShiftOffersViewResponseTemplate"},"viewTradesResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListUserTrades' or 'SearchTrades'","$ref":"#/definitions/AlternativeShiftTradesViewResponseTemplate"},"bulkUpdateTradesResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'BulkUpdateTrades'","$ref":"#/definitions/AlternativeShiftBulkUpdateTradesResponseTemplate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlternativeShiftSearchOffersRequest":{"type":"object","required":["initiatingShift","queryWeekDate","schedule"],"properties":{"schedule":{"description":"The existing schedule being used to find alternative shift offers","$ref":"#/definitions/AlternativeShiftScheduleLookup"},"queryWeekDate":{"type":"string","format":"date","description":"The start date for the week in this schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"initiatingShift":{"description":"The shift a user puts up for alternative shift offers","$ref":"#/definitions/InitiatingAlternativeShift"},"acceptableIntervals":{"type":"array","description":"The acceptable intervals in offers. 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"}}}},"InitiatingAlternativeShift":{"type":"object","required":["id","startDate"],"properties":{"id":{"type":"string","description":"The ID of the shift from a user's schedule"},"startDate":{"type":"string","format":"date-time","description":"The start date for the shift in the user's schedule in ISO-8601 format. For example: YYYY-MM-DDThh:mm:ss.SSSZ"}}},"CreateAlternativeShiftTradeRequest":{"type":"object","required":["alternativeShiftTradeGranularity","jobId"],"properties":{"jobId":{"type":"string","description":"The ID of this alternative shift job"},"dropShiftReferenceKeys":{"type":"array","description":"A list of offered shift reference keys an agent wants to drop","items":{"type":"string"}},"pickupShiftReferenceKeys":{"type":"array","description":"A list of offered shift reference keys an agent wants to pick up","items":{"type":"string"}},"alternativeShiftTradeGranularity":{"type":"string","description":"The granularity of alternative shifts to be traded","enum":["Daily"]},"expirationDate":{"type":"string","format":"date-time","description":"The date when the trade will expire in ISO-8601 format. The trade cannot be approved after expiration"}}},"ListAlternativeShiftTradesResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the request. Null if result returns synchronously","$ref":"#/definitions/AlternativeShiftJobResponse"},"result":{"description":"The result of the request. May come via notification. Null if job is populated","$ref":"#/definitions/AlternativeShiftTradeListing"}}},"AgentUpdateAlternativeShiftTradeRequest":{"type":"object","required":["metadata"],"properties":{"state":{"type":"string","description":"The new state of this alternative shift trade","enum":["Canceled"]},"metadata":{"description":"Version metadata for this alternative shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AdminBulkUpdateAlternativeShiftTradeState":{"type":"object","required":["metadata","state","tradeId"],"properties":{"tradeId":{"type":"string","description":"The ID of the trade for this alternative shift trade"},"state":{"type":"string","description":"The new alternative shift trade state","enum":["Approved","Denied"]},"metadata":{"description":"Version metadata for this alternative shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AdminBulkUpdateAlternativeShiftTradeStateRequest":{"type":"object","required":["managementUnitId"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AdminBulkUpdateAlternativeShiftTradeState"}},"managementUnitId":{"type":"string","description":"The ID of the management unit for this alternative shift bulk trade update"}}},"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"}}},"AgentWorkPlanBid":{"type":"object","required":["bidWindowEndDate","bidWindowStartDate","effectiveDate","id","status","workPlanFieldsVisibleToAgents"],"properties":{"id":{"type":"string","description":"The ID of the work plan bid"},"name":{"type":"string"},"bidWindowStartDate":{"type":"string","format":"date","description":"The date when agents can start participating in work plan bidding. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"bidWindowEndDate":{"type":"string","format":"date","description":"The inclusive end date of a bid window. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"effectiveDate":{"type":"string","format":"date","description":"The date when agents will be assigned to the new work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"status":{"type":"string","description":"The state of the bid","enum":["Draft","Locked","Optimized","Scheduled","Open","Closed","Processed","Published"]},"workPlanFieldsVisibleToAgents":{"type":"array","description":"The work plan fields visible to agents whenever work plan preferences are made","items":{"type":"string","enum":["Name","PaidHours"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan bid reference"},"AgentWorkPlanBids":{"type":"object","required":["agentWorkPlanBids"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"businessUnit":{"description":"The business unit to which the bids belong","$ref":"#/definitions/BusinessUnitReference"},"agentWorkPlanBids":{"type":"array","description":"Work plan bid summaries associated with this agent","items":{"$ref":"#/definitions/AgentWorkPlanBid"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentWorkPlanBiddingPreference":{"type":"object","required":["workPlan"],"properties":{"workPlan":{"description":"The work plan that belongs to the agent's bid group","$ref":"#/definitions/WorkPlanReference"},"priority":{"type":"integer","format":"int32","description":"The agent's priority for this work plan, with 1 being the best priority. Null if priority is not set for the work plan"}}},"AgentWorkPlanBiddingPreferenceResponse":{"type":"object","required":["agentWorkPlanBidPreferences","submitted"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"submitted":{"type":"boolean","description":"Whether the preference is submitted"},"assignedWorkPlan":{"description":"The work plan assigned to the agent by the bid process","$ref":"#/definitions/WorkPlanReference"},"overriddenWorkPlan":{"description":"The work plan that overrides the assigned work plan for the agent","$ref":"#/definitions/WorkPlanReference"},"overrideReason":{"type":"string","description":"The reason why the assigned work plan has been overridden. This must be null without an override work plan","enum":["UnableToBid","ChangeOfCircumstance","NewHire","EmployeeMove"]},"agentWorkPlanBidPreferences":{"type":"array","description":"The list of work plan bidding preferences","items":{"$ref":"#/definitions/AgentWorkPlanBiddingPreference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentWorkPlanBiddingPreferenceRequest":{"type":"object","required":["workPlanId"],"properties":{"workPlanId":{"type":"string","description":"The ID of the work plan that belongs to agent's bid group"},"priority":{"type":"integer","format":"int32","description":"The agent's priority for this work plan, with 1 being the best priority. Null if priority is not set for the work plan"}}},"UpdateAgentWorkPlanBiddingPreference":{"type":"object","required":["agentWorkPlanBidPreferences","submitted"],"properties":{"submitted":{"type":"boolean","description":"Whether the preference is submitted"},"agentWorkPlanBidPreferences":{"type":"array","description":"The list of work plan bidding preferences","items":{"$ref":"#/definitions/AgentWorkPlanBiddingPreferenceRequest"}}}},"AgentWorkPlan":{"type":"object","required":["constrainWeeklyPaidTime","flexibleWeeklyPaidTime","shifts","weeklyExactPaidMinutes","weeklyMaximumPaidMinutes","weeklyMinimumPaidMinutes"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"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"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/AgentWorkPlanShift"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentWorkPlanActivity":{"type":"object","required":["countsAsPaidTime","lengthMinutes"],"properties":{"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"}}},"AgentWorkPlanListResponse":{"type":"object","required":["managementUnit"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentWorkPlan"}},"managementUnit":{"description":"The management unit of the work plans","$ref":"#/definitions/ManagementUnitReference"}}},"AgentWorkPlanShift":{"type":"object","required":["activities","constrainLatestStopTime","days","earliestStartTimeMinutesFromMidnight","earliestStopTimeMinutesFromMidnight","exactPaidTimeMinutes","exactStartTimeMinutesFromMidnight","flexiblePaidTime","flexibleStartTime","latestStartTimeMinutesFromMidnight","latestStopTimeMinutesFromMidnight","maximumPaidTimeMinutes","minimumPaidTimeMinutes"],"properties":{"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"},"earliestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"This is the earliest time a shift can end"},"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"},"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"},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/AgentWorkPlanActivity"}}}},"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 week date of the initiating shift of the shift trade in yyyy-MM-dd format"},"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"}}}},"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"}}}},"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"}}}},"ActivityCodesReference":{"type":"object","properties":{"ids":{"type":"array","description":"The IDs of activity codes","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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"}}},"WorkPlanBidGroupSummary":{"type":"object","required":["agentCount","managementUnit","name","planningGroupCount","workPlanCount"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name assigned to this bid group"},"managementUnit":{"description":"The management unit this bid group belongs to","$ref":"#/definitions/ManagementUnitReference"},"agentCount":{"type":"integer","format":"int32","description":"The number of agents in this bid group"},"workPlanCount":{"type":"integer","format":"int32","description":"The number of work plans in this bid group"},"planningGroupCount":{"type":"integer","format":"int32","description":"The number of planning groups in this bid group"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanBidGroupSummaryList":{"type":"object","required":["workPlanBidGroupSummaryList"],"properties":{"workPlanBidGroupSummaryList":{"type":"array","description":"List of work plan bid group summary","items":{"$ref":"#/definitions/WorkPlanBidGroupSummary"}}}},"AgentCountRange":{"type":"object","required":["maximum","minimum"],"properties":{"minimum":{"type":"integer","format":"int32","description":"The minimum value of agent count per work plan"},"maximum":{"type":"integer","format":"int32","description":"The maximum value of agent count per work plan"}}},"BidGroupWorkPlanResponse":{"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"},"overrideAgentCount":{"type":"integer","format":"int32","description":"The modified agent count for this work plan"},"suggestedAgentCount":{"type":"integer","format":"int32","description":"The number of agents needed for this work plan to produce the optimal schedule","readOnly":true},"agentCountRange":{"description":"The range of agent slot count per work plan. The suggested slot count must be in agent count range","readOnly":true,"$ref":"#/definitions/AgentCountRange"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanBidGroup":{"type":"object","required":["agents","managementUnit","name","planningGroups","workPlans"],"properties":{"name":{"type":"string","description":"The name of the work plan bid group"},"managementUnit":{"description":"The management unit this bid group belongs to","$ref":"#/definitions/ManagementUnitReference"},"agents":{"type":"array","description":"The list of agents who participate in this bid group","items":{"$ref":"#/definitions/UserReference"}},"workPlans":{"type":"array","description":"The list of work plans used in this bid group","items":{"$ref":"#/definitions/BidGroupWorkPlanResponse"}},"planningGroups":{"type":"array","description":"The list of planning groups selected in this bid group","items":{"$ref":"#/definitions/PlanningGroupReference"}}}},"WorkPlanBidGroupResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"workPlanBidGroup":{"description":"The work plan bid group","$ref":"#/definitions/WorkPlanBidGroup"},"metadata":{"description":"The meta data of the bid group","$ref":"#/definitions/WorkPlanBidMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanBidMetadata":{"type":"object","required":["createdBy","createdDate"],"properties":{"createdBy":{"description":"The user who created the associated entity","$ref":"#/definitions/UserReference"},"createdDate":{"type":"string","format":"date-time","description":"The date the entity created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user who modified the entity","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The entity last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BidGroupWorkPlanRequest":{"type":"object","required":["workPlanId"],"properties":{"workPlanId":{"type":"string","description":"The ID of the work plan used in the bid group"},"overrideAgentCount":{"type":"integer","format":"int32","description":"The modified agent count for this work plan"},"suggestedAgentCount":{"type":"integer","format":"int32","description":"The number of agents needed for this work plan to produce the optimal schedule","readOnly":true},"agentCountRange":{"description":"The range of agent slot count per work plan. The suggested slot count must be in agent count range","readOnly":true,"$ref":"#/definitions/AgentCountRange"}}},"WorkPlanBidGroupCreate":{"type":"object","required":["agentIds","managementUnitId","name","planningGroupIds","workPlans"],"properties":{"name":{"type":"string","description":"The name of the work plan bid group"},"managementUnitId":{"type":"string","description":"The management unit ID this bid group belongs to"},"agentIds":{"type":"array","description":"Agent IDs who participate in this bid group","items":{"type":"string"}},"workPlans":{"type":"array","description":"The list of work plans used in this bid group","items":{"$ref":"#/definitions/BidGroupWorkPlanRequest"}},"planningGroupIds":{"type":"array","description":"The planning group IDs selected in this bid group","items":{"type":"string"}}}},"ListWrapperBidGroupWorkPlanRequest":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/BidGroupWorkPlanRequest"}}}},"WorkPlanBidGroupUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the work plan bid group"},"managementUnitId":{"type":"string","description":"The management unit ID used for this work plan bid group"},"agentIds":{"description":"Agent IDs who participate in this bid group","$ref":"#/definitions/ListWrapperString"},"workPlans":{"description":"The list of work plans used in this bid group","$ref":"#/definitions/ListWrapperBidGroupWorkPlanRequest"},"planningGroupIds":{"description":"The planning group IDs selected in this bid group","$ref":"#/definitions/ListWrapperString"}}},"AdminAgentWorkPlanBiddingPreference":{"type":"object","required":["agent","submitted"],"properties":{"agent":{"description":"The agent to whom this work plan bidding preference applies","$ref":"#/definitions/UserReference"},"submitted":{"type":"boolean","description":"Whether the preference is submitted"},"assignedWorkPlan":{"description":"The work plan assigned to the agent by the bid process","$ref":"#/definitions/WorkPlanReference"},"overriddenWorkPlan":{"description":"The work plan that overrides the assigned work plan for the agent","$ref":"#/definitions/WorkPlanReference"},"overrideReason":{"type":"string","description":"The reason why the assigned work plan has been overridden. This must be null without an override work plan","enum":["UnableToBid","ChangeOfCircumstance","NewHire","EmployeeMove"]},"priorities":{"type":"array","description":"The agent priorities for the list of work plans. The index of the priorities should match with the list of work plans that belong to bid group. It contains null if priority is not set for the work plan","items":{"type":"integer","format":"int32"}}}},"AdminAgentWorkPlanPreferenceResponse":{"type":"object","required":["agentWorkPlanBidPreferences","workPlans"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"workPlans":{"type":"array","description":"The list of work plans that belong to this bid group","items":{"$ref":"#/definitions/WorkPlanReference"}},"agentWorkPlanBidPreferences":{"type":"array","description":"The list of agents work plan bidding preferences","items":{"$ref":"#/definitions/AdminAgentWorkPlanBiddingPreference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentBidWorkPlanOverrideRequest":{"type":"object","required":["agentId"],"properties":{"agentId":{"type":"string","description":"The ID of agent"},"overrideWorkPlanId":{"type":"string","description":"The ID of the work plan that overrides the assigned work plan for the agent"},"overrideReason":{"type":"string","description":"The reason for overriding the assigned work plan. This must be null if overrideWorkPlanId is not specified","enum":["UnableToBid","ChangeOfCircumstance","NewHire","EmployeeMove"]}}},"AgentsBidAssignedWorkPlanOverrideRequest":{"type":"object","required":["agentWorkPlanOverrides"],"properties":{"agentWorkPlanOverrides":{"type":"array","description":"The list of agent work plan overrides","items":{"$ref":"#/definitions/AgentBidWorkPlanOverrideRequest"}}}},"BuShortTermForecastWeekReference":{"type":"object","required":["id","weekDate","weekNumber"],"properties":{"id":{"type":"string","description":"Forecast id used in this work plan bid"},"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},"weekNumber":{"type":"integer","format":"int32","description":"The week number used for this bid. First week starts with number 1"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanBid":{"type":"object","required":["agentRankingType","bidWindowEndDate","bidWindowStartDate","effectiveDate","id","name","rankingTiebreakerType","status","workPlanFieldsVisibleToAgents"],"properties":{"id":{"type":"string","description":"The ID of the work plan bid"},"name":{"type":"string","description":"The name of the work plan bid"},"forecast":{"description":"The selected forecast in this work plan bid","$ref":"#/definitions/BuShortTermForecastWeekReference"},"bidWindowStartDate":{"type":"string","format":"date","description":"The bid start date where agents start participate in work plan bidding. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"bidWindowEndDate":{"type":"string","format":"date","description":"The bid end date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"effectiveDate":{"type":"string","format":"date","description":"The date when agents will be assigned to the new work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"status":{"type":"string","description":"The state of the bid","enum":["Draft","Locked","Optimized","Scheduled","Open","Closed","Processed","Published"]},"agentRankingType":{"type":"string","description":"The type of agent ranking selected for this bid","enum":["HireDate","Performance"]},"rankingTiebreakerType":{"type":"string","description":"Ranking tiebreaker","enum":["HireDate","Performance","Custom","RandomlyAssign"]},"publishedDate":{"type":"string","format":"date-time","description":"The date the work plan bid published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"workPlanFieldsVisibleToAgents":{"type":"array","description":"The work plan fields visible to agents whenever work plan preferences are made","items":{"type":"string","enum":["Name","PaidHours"]}},"metadata":{"description":"The meta data of this bid","$ref":"#/definitions/WorkPlanBidMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan bid response"},"CreateWorkPlanBid":{"type":"object","required":["agentRankingType","bidWindowEndDate","bidWindowStartDate","effectiveDate","name","rankingTiebreakerType","workPlanFieldsVisibleToAgents"],"properties":{"name":{"type":"string","description":"The name of the work plan bid"},"forecast":{"description":"The selected forecast in this work plan bid","$ref":"#/definitions/BuShortTermForecastWeekReference"},"bidWindowStartDate":{"type":"string","format":"date","description":"The bid start date where agents start participate in work plan bidding in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"bidWindowEndDate":{"type":"string","format":"date","description":"The bid end date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"effectiveDate":{"type":"string","format":"date","description":"The date when agents will be assigned to the new work plan in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"agentRankingType":{"type":"string","description":"The type of agent ranking selected for this bid","enum":["HireDate","Performance"]},"rankingTiebreakerType":{"type":"string","description":"Ranking tiebreaker to be used","enum":["HireDate","Performance","Custom","RandomlyAssign"]},"workPlanFieldsVisibleToAgents":{"type":"array","description":"The work plan fields visible to agents whenever work plan preferences are made","items":{"type":"string","enum":["Name","PaidHours"]}}},"description":"Create work plan bid model"},"WorkPlanBidListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanBid"}}}},"ListWrapperAgentWorkPlanField":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string","enum":["Name","PaidHours"]}}}},"UpdateWorkPlanBid":{"type":"object","properties":{"name":{"type":"string","description":"The name of the work plan bid"},"forecast":{"description":"The selected forecast in this work plan bid","$ref":"#/definitions/BuShortTermForecastWeekReference"},"bidWindowStartDate":{"type":"string","format":"date","description":"The bid start date where agents start participate in work plan bidding in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"bidWindowEndDate":{"type":"string","format":"date","description":"The bid end date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"effectiveDate":{"type":"string","format":"date","description":"The date when agents will be assigned to the new work plan in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"agentRankingType":{"type":"string","description":"The type of agent ranking selected for this bid","enum":["HireDate","Performance"]},"rankingTiebreakerType":{"type":"string","description":"Ranking tiebreaker","enum":["HireDate","Performance","Custom","RandomlyAssign"]},"workPlanFieldsVisibleToAgents":{"description":"The work plan fields visible to agents whenever work plan preferences are made","$ref":"#/definitions/ListWrapperAgentWorkPlanField"},"status":{"type":"string","description":"The state of the bid","enum":["Draft","Locked","Optimized","Scheduled","Open","Closed","Processed","Published"]}},"description":"Update work plan bid model"},"CopyWorkPlanBid":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the new work plan bid"}}},"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}}},"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}}},"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"}}},"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 512 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 512 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."}}},"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"}}},"WorkitemScriptReference":{"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}}},"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}}},"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 512 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."},"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."},"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"}},"wrapupCode":{"type":"string","description":"The ID of the wrapup. Must be a valid UUID."},"utilizationLabelId":{"type":"string","description":"The ID of utilization label of the Workitem. Must be a valid UUID."}}},"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}}},"WorkitemPagedEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Workitem"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"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"}},"queryFilters":{"type":"array","description":"Query filters for nested attributes.","items":{"$ref":"#/definitions/WorkitemQueryJobQueryFilters"},"maxItems":1,"minItems":1},"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"},"dateIntervalStart":{"type":"string","format":"date-time","description":"Interval start date to use to filter results based on create date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateIntervalEnd":{"type":"string","format":"date-time","description":"Interval end date to use to filter results based on create date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"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"}}}},"WorkitemQueryJobQueryFilters":{"type":"object","required":["criteria","name"],"properties":{"name":{"type":"string","example":"customFields","description":"Name of the attribute to filter.","enum":["customFields"]},"operator":{"type":"string","description":"Query filter logical operator to join criteria.","enum":["AND","OR"]},"criteria":{"type":"array","description":"Query filter criteria.","items":{"$ref":"#/definitions/WorkitemQueryJobQueryFiltersCriteria"},"maxItems":5,"minItems":1}}},"WorkitemQueryJobQueryFiltersCriteria":{"type":"object","required":["predicates"],"properties":{"operator":{"type":"string","description":"Query filter logical operator to join predicates.","enum":["AND","OR"]},"predicates":{"type":"array","description":"Query filter predicate.","items":{"$ref":"#/definitions/WorkitemQueryJobQueryFiltersPredicate"},"maxItems":3,"minItems":1}}},"WorkitemQueryJobQueryFiltersPredicate":{"type":"object","required":["name","operator"],"properties":{"name":{"type":"string","description":"Property name."},"operator":{"type":"string","description":"Query filter predicate operator.","enum":["EQ","NEQ","GT","LT","GTE","LTE","IN","CONTAINS","BETWEEN","BEGINS_WITH","EXISTS"]},"values":{"type":"array","description":"List of values to be used in the query filter predicate.","items":{"type":"object"}}}},"WorkitemQueryJobSort":{"type":"object","properties":{"name":{"type":"string","description":"Specify an attribute for sorting.","enum":["dateDue","priority"]},"ascending":{"type":"boolean","description":"Sort Ascending"}}},"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 512 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"},"autoTerminateWorkitem":{"type":"boolean","description":"Terminate workitem on selection of status. Applicable only for statuses in the Closed category."},"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 512 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"}}},"WorkitemFlowReference":{"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}}},"WorkitemRuleSettings":{"type":"object","properties":{"flowRulesEnabled":{"type":"boolean","description":"When set to true, the worktypes flow rules will be processed. Default value is false."}}},"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."},"ruleSettings":{"description":"Settings for the worktypes rules.","$ref":"#/definitions/WorkitemRuleSettings"},"flow":{"description":"The flow associated with the Worktype.","$ref":"#/definitions/WorkitemFlowReference"},"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 512 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},"ruleSettings":{"description":"Settings for the worktypes rules.","$ref":"#/definitions/WorkitemRuleSettings"},"description":{"type":"string","description":"The description of the Worktype. Maximum length of 512 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. 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},"ruleSettings":{"description":"Settings for the worktypes rules.","$ref":"#/definitions/WorkitemRuleSettings"},"description":{"type":"string","description":"The description of the Worktype. Maximum length of 512 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"}}}},"WorkitemRuleAction":{"type":"object","properties":{"type":{"type":"string","enum":["LaunchFlow"]}}},"WorkitemOnAttributeChangeCondition":{"type":"object","required":["attribute","newValue"],"properties":{"attribute":{"type":"string","description":"The name of the workitem attribute whose change will be evaluated as part of the rule.","enum":["statusId"]},"newValue":{"type":"string","description":"The new value of the attribute. If the attribute is updated to this value this part of the condition will be met."},"oldValue":{"type":"string","description":"The old value of the attribute. If the attribute was updated from this value this part of the condition will be met."}}},"WorkitemOnAttributeChangeRule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"The type of the rule.","enum":["OnCreate","OnAttributeChange","Date"]},"action":{"description":"The rules action. If the condition criteria is met this action will be executed.","$ref":"#/definitions/WorkitemRuleAction"},"worktype":{"description":"The Worktype containing the rule.","$ref":"#/definitions/WorktypeReference"},"condition":{"description":"The rules condition. If the condition criteria is met the rules action will be executed.","$ref":"#/definitions/WorkitemOnAttributeChangeCondition"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemOnAttributeChangeConditionUpdate":{"type":"object","required":["attribute","newValue"],"properties":{"attribute":{"type":"string","description":"The name of the workitem attribute whose change will be evaluated as part of the rule.","enum":["statusId"]},"newValue":{"type":"string","description":"The new value of the attribute. If the attribute is updated to this value this part of the condition will be met."},"oldValue":{"type":"string","description":"The old value of the attribute. If the attribute was updated from this value this part of the condition will be met."}}},"WorkitemOnAttributeChangeRuleUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the rule."},"condition":{"description":"The rules condition. If the condition criteria is met the rules action will be executed.","$ref":"#/definitions/WorkitemOnAttributeChangeConditionUpdate"}}},"WorkitemOnAttributeChangeRuleCreate":{"type":"object","required":["condition","name"],"properties":{"name":{"type":"string","description":"The name of the rule."},"condition":{"description":"The rules condition. If the condition criteria is met the rules action will be executed.","$ref":"#/definitions/WorkitemOnAttributeChangeCondition"}}},"WorkitemOnAttributeChangeRuleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkitemOnCreateRule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"The type of the rule.","enum":["OnCreate","OnAttributeChange","Date"]},"action":{"description":"The rules action. If the condition criteria is met this action will be executed.","$ref":"#/definitions/WorkitemRuleAction"},"worktype":{"description":"The Worktype containing the rule.","$ref":"#/definitions/WorktypeReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemOnCreateRuleUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the rule."}}},"WorkitemOnCreateRuleCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the rule."}}},"WorkitemOnCreateRuleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}}},"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"}},"409":{"description":"The request conflicts with the current state of the target resource.","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":"Identity Provider","description":"Identity providers","externalDocs":{"description":"Identity Providers Documentation","url":"https://developer.genesys.cloud/authorization/oauth-apis/identityprovider/"}},{"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":"Organization","description":"Organization","externalDocs":{"description":"Organization Documentation","url":"https://developer.genesys.cloud/organization/organization/"}},{"name":"Tokens","description":"Authentication Tokens","externalDocs":{"description":"Tokens Documentation","url":"https://developer.mypurecloud.com/api/rest/v2/tokens/"}},{"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":"Agent UI","description":"Agent UI settings and configuration"},{"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":"Agent Assistants","description":"Manage virtual agent assistants."},{"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":"Data Privacy","description":"Data privacy masking rules","externalDocs":{"description":"Data Privacy","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":"Employee Engagement","description":"Employee Engagement","externalDocs":{"description":"Employee Engagement Documentation","url":"https://developer.genesys.cloud/useragentman/employeeengagement/"}},{"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":"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 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":"Test Automation","description":"Internal Testing Tool for managing Testing Data"},{"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":"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"},{"name":"Agent Copilot","description":"Manage agent copilot configuration."}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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]","api.exclusion.list.limit.exceeded":"Inactivity Timeout API exclusion list limit exceeded","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/users/agentui/agents/autoanswer/{agentId}/settings":{"get":{"tags":["Agent UI","Settings"],"summary":"Get agent auto answer settings","description":"","operationId":"getUsersAgentuiAgentsAutoanswerAgentIdSettings","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent to apply the auto answer settings to","required":true,"type":"string"}],"responses":{"200":{"description":"Auto answer settings retrieved successfully","schema":{"$ref":"#/definitions/AutoAnswerSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["agentUI:agents:view"]},"x-purecloud-method-name":"getUsersAgentuiAgentsAutoanswerAgentIdSettings"},"put":{"tags":["Agent UI","Settings"],"summary":"Set agent auto answer settings","description":"","operationId":"putUsersAgentuiAgentsAutoanswerAgentIdSettings","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent to apply the auto answer settings to","required":true,"type":"string"},{"in":"body","name":"body","description":"AutoAnswerSettings","required":true,"schema":{"$ref":"#/definitions/AutoAnswerSettings"}}],"responses":{"200":{"description":"Auto answer settings set successfully","schema":{"$ref":"#/definitions/AutoAnswerSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["agentUI:agents:edit"]},"x-purecloud-method-name":"putUsersAgentuiAgentsAutoanswerAgentIdSettings"},"delete":{"tags":["Agent UI","Settings"],"summary":"Delete agent auto answer settings","description":"","operationId":"deleteUsersAgentuiAgentsAutoanswerAgentIdSettings","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent to apply the auto answer settings to","required":true,"type":"string"}],"responses":{"204":{"description":"Auto answer settings 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["agentUI:agents:delete"]},"x-purecloud-method-name":"deleteUsersAgentuiAgentsAutoanswerAgentIdSettings"},"patch":{"tags":["Agent UI","Settings"],"summary":"Update agent auto answer settings","description":"","operationId":"patchUsersAgentuiAgentsAutoanswerAgentIdSettings","produces":["application/json"],"parameters":[{"name":"agentId","in":"path","description":"The agent to apply the auto answer settings to","required":true,"type":"string"},{"in":"body","name":"body","description":"AutoAnswerSettings","required":true,"schema":{"$ref":"#/definitions/AutoAnswerSettings"}}],"responses":{"200":{"description":"Auto answer settings updated successfully","schema":{"$ref":"#/definitions/AutoAnswerSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["agentUI:agents:edit"]},"x-purecloud-method-name":"patchUsersAgentuiAgentsAutoanswerAgentIdSettings"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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).","general.forbidden":"Forbidden to create an interaction stats rule.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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 reach 90% of the maximum. 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. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. It is expected that the client will URL encode the request URI once only. 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. The 'nextUri' value in the response is already URL encoded (so it doesn't need to be encoded again). 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","SkippedCollection","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. It is expected that the client will URL encode the request URI once only. 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. The 'nextUri' value in the response is already URL encoded (so it doesn't need to be encoded again). 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","SkippedCollection","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. It is expected that the client will URL encode the request URI once only. 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. The 'nextUri' value in the response is already URL encoded (so it doesn't need to be encoded again). 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 soft delete 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"name","in":"query","description":"name of the dashboard","required":false,"type":"string"},{"name":"dashboardType","in":"query","description":"List dashboard of given type","required":true,"type":"string","enum":["All","Public","Private","Shared","Favorites","Deleted"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]},{"name":"deletedOnly","in":"query","description":"Only list deleted dashboards that are still recoverable","required":false,"type":"boolean"}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 soft 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"deletedOnly","in":"query","description":"If true, retrieve only deleted dashboards that are still recoverable","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/assistants/{assistantId}/copilot":{"get":{"tags":["Agent Copilot"],"summary":"Get copilot configuration of an assistant.","description":"","operationId":"getAssistantCopilot","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Copilot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:copilot:view"]},"x-purecloud-method-name":"getAssistantCopilot"},"put":{"tags":["Agent Copilot"],"summary":"Update agent copilot configuration","description":"","operationId":"putAssistantCopilot","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Copilot"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Copilot"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:copilot:edit"]},"x-purecloud-method-name":"putAssistantCopilot"}},"/api/v2/assistants/{assistantId}/queues/{queueId}":{"get":{"tags":["Agent Assistants"],"summary":"Get queue Information for an assistant.","description":"","operationId":"getAssistantQueue","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["assistant"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:view"]},"x-purecloud-method-name":"getAssistantQueue"},"put":{"tags":["Agent Assistants"],"summary":"Create a queue assistant association.","description":"","operationId":"putAssistantQueue","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/AssistantQueue"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueue"}},"201":{"description":"Created","schema":{"$ref":"#/definitions/AssistantQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:edit"]},"x-purecloud-method-name":"putAssistantQueue"},"delete":{"tags":["Agent Assistants"],"summary":"Disassociate a queue from an assistant.","description":"","operationId":"deleteAssistantQueue","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"}],"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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:delete"]},"x-purecloud-method-name":"deleteAssistantQueue"}},"/api/v2/assistants/{assistantId}/queues":{"get":{"tags":["Agent Assistants"],"summary":"Get all the queues associated with an assistant.","description":"","operationId":"getAssistantQueues","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant 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":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["assistant"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueueListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:view"]},"x-purecloud-method-name":"getAssistantQueues"},"delete":{"tags":["Agent Assistants"],"summary":"Disassociate the queues from an assistant for the given assistant ID and queue IDs.","description":"","operationId":"deleteAssistantQueues","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"queueIds","in":"query","description":"Comma-separated identifiers of the queues that need to be deleted.","required":false,"type":"string"}],"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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","conflict":"Deleting queues from an assistant 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":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:delete"]},"x-purecloud-method-name":"deleteAssistantQueues"},"patch":{"tags":["Agent Assistants"],"summary":"Update Queues for an Assistant.","description":"","operationId":"patchAssistantQueues","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/AssistantQueue"}}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueueListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:edit"]},"x-purecloud-method-name":"patchAssistantQueues"}},"/api/v2/assistants/{assistantId}":{"get":{"tags":["Agent Assistants"],"summary":"Get an assistant.","description":"","operationId":"getAssistant","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["copilot"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assistant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:view"]},"x-purecloud-method-name":"getAssistant"},"delete":{"tags":["Agent Assistants"],"summary":"Delete an assistant.","description":"","operationId":"deleteAssistant","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"}],"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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:delete"]},"x-purecloud-method-name":"deleteAssistant"},"patch":{"tags":["Agent Assistants"],"summary":"Update an assistant.","description":"","operationId":"patchAssistant","produces":["application/json"],"parameters":[{"name":"assistantId","in":"path","description":"Assistant ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Assistant"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assistant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:edit"]},"x-purecloud-method-name":"patchAssistant"}},"/api/v2/assistants":{"get":{"tags":["Agent Assistants"],"summary":"Get all assistants.","description":"","operationId":"getAssistants","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":"name","in":"query","description":"Return the assistant by the given name.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:view"]},"x-purecloud-method-name":"getAssistants"},"post":{"tags":["Agent Assistants"],"summary":"Create an Assistant.","description":"","operationId":"postAssistants","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/Assistant"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Assistant"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:assistant:add"]},"x-purecloud-method-name":"postAssistants"}},"/api/v2/assistants/queues":{"get":{"tags":["Agent Assistants"],"summary":"Get all queues assigned to any assistant.","description":"","operationId":"getAssistantsQueues","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":"queueIds","in":"query","description":"Comma-separated identifiers of the queues that need to be retrieved.","required":false,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["assistant"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueueListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:view"]},"x-purecloud-method-name":"getAssistantsQueues"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"allowRedirect","in":"query","description":"Result sets with large amounts of data will respond with a download url","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AuditQueryExecutionResultsResponse"}},"302":{"description":"Result set too large to be returned in the response. Please use the returned download url or reduce the page size. Downloaded results will not be expanded.","schema":{"$ref":"#/definitions/AuditQueryExecutionLargeResultsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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]","insufficient.permissions":"Insufficient permissions to assign a list of objects to a 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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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":["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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/UserReferenceEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/settings":{"get":{"tags":["Authorization"],"summary":"Get authorization role settings","description":"","operationId":"getAuthorizationRolesSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoleSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getAuthorizationRolesSettings"},"put":{"tags":["Authorization"],"summary":"Change authorization role settings","description":"Change role settings","operationId":"putAuthorizationRolesSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Authorization Role Settings","required":true,"schema":{"$ref":"#/definitions/RoleSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RoleSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"putAuthorizationRolesSettings"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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]","max.roles.exceeded":"Cannot create role because maximum number of role is exceeded.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","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","request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","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","request.conflict":"The request conflicts with the current state of the target resource.","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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","forbidden":"Forbidden from removing a user from a room.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources","identifiers","externalSources","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/ContactIdentifierListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"identifier.claim.conflict":"Identifier is already claimed","request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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","identifiers","externalSources","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","identifiers","externalSources","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","required":false,"type":"array","items":{"type":"string","enum":["externalDataSources","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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/externalsources/{externalSourceId}":{"get":{"tags":["External Contacts"],"summary":"Fetch an External Source","description":"","operationId":"getExternalcontactsExternalsource","produces":["application/json"],"parameters":[{"name":"externalSourceId","in":"path","description":"External Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 source not found by external source 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:externalSource:view","externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsExternalsource"},"put":{"tags":["External Contacts"],"summary":"Update an External Source","description":"","operationId":"putExternalcontactsExternalsource","produces":["application/json"],"parameters":[{"name":"externalSourceId","in":"path","description":"External Source ID","required":true,"type":"string"},{"in":"body","name":"body","description":"External Source","required":true,"schema":{"$ref":"#/definitions/ExternalSource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 source not found by external source 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","active.external.source.limit.reached":"The number of active External Sources in org limit reached","external.source.exists":"External Source with 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."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"The provided external source data 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:externalSource:edit"]},"x-purecloud-method-name":"putExternalcontactsExternalsource"},"delete":{"tags":["External Contacts"],"summary":"Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.","description":"","operationId":"deleteExternalcontactsExternalsource","produces":["application/json"],"parameters":[{"name":"externalSourceId","in":"path","description":"External Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Empty"}},"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":{"entity.not.found":"External source not found by external source 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:externalSource:delete"]},"x-purecloud-method-name":"deleteExternalcontactsExternalsource"}},"/api/v2/externalcontacts/externalsources":{"get":{"tags":["External Contacts"],"summary":"Fetch a list of External Sources","description":"","operationId":"getExternalcontactsExternalsources","produces":["application/json"],"parameters":[{"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"},{"name":"limit","in":"query","description":"The number of ExternalSources per page; must be between 10 and 200, default is 100","required":false,"type":"integer","format":"int32"},{"name":"name","in":"query","description":"Filter by external source name. Filtering is prefix filtering and not an exact match","required":false,"type":"string"},{"name":"active","in":"query","description":"Filter by active status of external source","required":false,"type":"boolean"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CursorExternalSourceListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:externalSource:view","externalContacts:contact:view","externalContacts:externalOrganization:view"]},"x-purecloud-method-name":"getExternalcontactsExternalsources"},"post":{"tags":["External Contacts"],"summary":"Create an External Source","description":"","operationId":"postExternalcontactsExternalsources","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"External Source","required":true,"schema":{"$ref":"#/definitions/ExternalSource"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ExternalSource"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","active.external.source.limit.reached":"The number of active External Sources in org limit reached","external.source.exists":"External Source with that name already exists","max.external.source.limit.reached":"The number of total External Sources in org 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."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"validation.failed":"Provided External source 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:externalSource:add"]},"x-purecloud-method-name":"postExternalcontactsExternalsources"}},"/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"}},{"name":"expand","in":"query","description":"which field, if any, to expand","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","identifiers","externalSources","division"]},"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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","required":false,"type":"array","items":{"type":"string","enum":["externalOrganization","externalDataSources","identifiers","division"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/externalcontacts/import/jobs/{jobId}":{"get":{"tags":["External Contacts"],"summary":"Get job based on id","description":"","operationId":"getExternalcontactsImportJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importJob:view"]},"x-purecloud-method-name":"getExternalcontactsImportJob"},"put":{"tags":["External Contacts"],"summary":"Update Job's workflow status","description":"","operationId":"putExternalcontactsImportJob","produces":["application/json"],"parameters":[{"name":"jobId","in":"path","description":"Job id","required":true,"type":"string"},{"in":"body","name":"body","description":"Status of the Job's workflow","required":true,"schema":{"$ref":"#/definitions/ContactImportJobStatusUpdateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactImportJobStatusUpdateResponse"}},"202":{"description":"Accepted - Workflow Status Update","schema":{"$ref":"#/definitions/ContactImportJobStatusUpdateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importJob:edit"]},"x-purecloud-method-name":"putExternalcontactsImportJob"}},"/api/v2/externalcontacts/import/jobs":{"get":{"tags":["External Contacts"],"summary":"List jobs for organization","description":"","operationId":"getExternalcontactsImportJobs","produces":["application/json"],"parameters":[{"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 100.","required":false,"type":"string","default":"25"},{"name":"sortOrder","in":"query","description":"Direction of sorting.","required":false,"type":"string","default":"Ascending","enum":["Ascending","Descending"]},{"name":"jobStatus","in":"query","description":"Search term to filter by jobStatus","required":false,"type":"string","enum":["Created","Running","Completed","Failed","Cancelled"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactImportJobEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importJob:viewAll"]},"x-purecloud-method-name":"getExternalcontactsImportJobs"},"post":{"tags":["External Contacts"],"summary":"Create a new job","description":"","operationId":"postExternalcontactsImportJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Job","required":true,"schema":{"$ref":"#/definitions/ContactImportJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactImportJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importJob:add"]},"x-purecloud-method-name":"postExternalcontactsImportJobs"}},"/api/v2/externalcontacts/import/settings/{settingsId}":{"get":{"tags":["External Contacts"],"summary":"Get setting based on id","description":"","operationId":"getExternalcontactsImportSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactImportSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importSettings:view"]},"x-purecloud-method-name":"getExternalcontactsImportSetting"},"put":{"tags":["External Contacts"],"summary":"Update settings","description":"","operationId":"putExternalcontactsImportSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"},{"in":"body","name":"body","description":"Setting","required":true,"schema":{"$ref":"#/definitions/ContactImportSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactImportSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","name.already.exists":"Settings with 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":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:importSettings:edit"]},"x-purecloud-method-name":"putExternalcontactsImportSetting"},"delete":{"tags":["External Contacts"],"summary":"Delete Settings","description":"","operationId":"deleteExternalcontactsImportSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"}],"responses":{"204":{"description":"Settings 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importSettings:delete"]},"x-purecloud-method-name":"deleteExternalcontactsImportSetting"}},"/api/v2/externalcontacts/import/settings":{"get":{"tags":["External Contacts"],"summary":"List settings for organization","description":"","operationId":"getExternalcontactsImportSettings","produces":["application/json"],"parameters":[{"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 100.","required":false,"type":"string","default":"25"},{"name":"sortOrder","in":"query","description":"Direction of sorting.","required":false,"type":"string","default":"Ascending","enum":["Ascending","Descending"]},{"name":"name","in":"query","description":"Search term to filter by settings name","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactImportSettingsEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importSettings:viewAll"]},"x-purecloud-method-name":"getExternalcontactsImportSettings"},"post":{"tags":["External Contacts"],"summary":"Create a new settings","description":"","operationId":"postExternalcontactsImportSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Setting","required":true,"schema":{"$ref":"#/definitions/ContactImportSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactImportSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","name.already.exists":"Settings with 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":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:importSettings:add"]},"x-purecloud-method-name":"postExternalcontactsImportSettings"}},"/api/v2/externalcontacts/import/csv/jobs":{"post":{"tags":["External Contacts"],"summary":"Create CSV import job","description":"","operationId":"postExternalcontactsImportCsvJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"ImportRequest","required":true,"schema":{"$ref":"#/definitions/CsvJobRequest"}}],"responses":{"202":{"description":"Accepted - CSV import job created","schema":{"$ref":"#/definitions/CsvJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.parameter":"Parameter 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","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.error":"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":["external-contacts"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["externalContacts:importCsvJob:add"]},"x-purecloud-method-name":"postExternalcontactsImportCsvJobs"}},"/api/v2/externalcontacts/import/csv/settings/{settingsId}":{"get":{"tags":["External Contacts"],"summary":"Get settings for CSV import","description":"","operationId":"getExternalcontactsImportCsvSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CsvSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:view"]},"x-purecloud-method-name":"getExternalcontactsImportCsvSetting"},"put":{"tags":["External Contacts"],"summary":"Update settings for CSV import","description":"","operationId":"putExternalcontactsImportCsvSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"},{"in":"body","name":"body","description":"Settings","required":true,"schema":{"$ref":"#/definitions/CsvSettings"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CsvSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.settings":"Invalid settings","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:edit"]},"x-purecloud-method-name":"putExternalcontactsImportCsvSetting"},"delete":{"tags":["External Contacts"],"summary":"Delete settings for CSV import","description":"","operationId":"deleteExternalcontactsImportCsvSetting","produces":["application/json"],"parameters":[{"name":"settingsId","in":"path","description":"Settings id","required":true,"type":"string"}],"responses":{"204":{"description":"Settings 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:delete"]},"x-purecloud-method-name":"deleteExternalcontactsImportCsvSetting"}},"/api/v2/externalcontacts/import/csv/settings":{"get":{"tags":["External Contacts"],"summary":"Retrieve all settings for organization filtered by externalSettingsId if provided","description":"","operationId":"getExternalcontactsImportCsvSettings","produces":["application/json"],"parameters":[{"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":"externalSettingsId","in":"query","description":"External Settings Id to filter the list.","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Listing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:view"]},"x-purecloud-method-name":"getExternalcontactsImportCsvSettings"},"post":{"tags":["External Contacts"],"summary":"Create settings for CSV import","description":"","operationId":"postExternalcontactsImportCsvSettings","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Settings","required":true,"schema":{"$ref":"#/definitions/CsvSettings"}}],"responses":{"201":{"description":"Settings created","schema":{"$ref":"#/definitions/CsvSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","settings.invalid":"Invalid settings","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvSettings:add"]},"x-purecloud-method-name":"postExternalcontactsImportCsvSettings"}},"/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details":{"get":{"tags":["External Contacts"],"summary":"Get details for CSV upload","description":"","operationId":"getExternalcontactsImportCsvUploadDetails","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CsvUploadDetailsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvUpload:view"]},"x-purecloud-method-name":"getExternalcontactsImportCsvUploadDetails"}},"/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview":{"get":{"tags":["External Contacts"],"summary":"Get preview for CSV upload","description":"","operationId":"getExternalcontactsImportCsvUploadPreview","produces":["application/json"],"parameters":[{"name":"uploadId","in":"path","description":"Upload id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/CsvUploadPreviewResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"invalid.upload":"Invalid upload"}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvUpload:view"]},"x-purecloud-method-name":"getExternalcontactsImportCsvUploadPreview"}},"/api/v2/externalcontacts/import/csv/uploads":{"post":{"tags":["External Contacts"],"summary":"Get url for CSV upload","description":"","operationId":"postExternalcontactsImportCsvUploads","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"UploadRequest","required":true,"schema":{"$ref":"#/definitions/CsvUploadRequest"}}],"responses":{"201":{"description":"Upload initiated","schema":{"$ref":"#/definitions/CsvUploadResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:importCsvUpload:add"]},"x-purecloud-method-name":"postExternalcontactsImportCsvUploads"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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":{"request.conflict":"The request conflicts with the current state of the target resource.","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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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","forbidden":"Forbidden from update 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."}},"409":{"description":"Resource conflict - Unexpected changeNumber was provided","x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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-inin-requires-permissions":{"type":"ANY","permissions":["content_management_user"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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":"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."},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"202":{"description":"Accepted","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":{"general.resource.not.found":"The resource 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","conversation.error.outbound.call.cannot.be.placed":"Outbound call cannot be placed.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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]","conversation.error.multiple.coaches":"Multiple coaches on the conversation.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","conversation.error.outbound.call.cannot.be.placed":"Outbound call cannot be placed."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"postino.error.reply.sending":"Error sending an email reply.","request.conflict":"The request conflicts with the current state of the target resource.","email.error.communication.conflict":"The email sending has communication conflict error."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/{conversationId}/participants/{participantId}/parkingstate":{"patch":{"tags":["Conversations"],"summary":"Update conversation by setting its parking state","description":"","operationId":"patchConversationsEmailParticipantParkingstate","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":"Parking update request","required":true,"schema":{"$ref":"#/definitions/ParkingStateRequest"}}],"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":{"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.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","conversation.error.unexpected.parking.state":"Unexpected parking state.","conversation.error.park.user.concurrent.max.exceeded":"Park failed because maximum concurrent parked communications 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.","general.bad.request":"The request could not be understood by the server due to malformed syntax.","postino.error.bad.request":"Bad Request","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:park"]},"x-purecloud-method-name":"patchConversationsEmailParticipantParkingstate"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/CreateOutboundMessagingConversationResponse"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/{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.","conversation.message.limit.exceeded":"Conversation max message limit has been reached.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded.","request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","conversation:socialmedia: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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"organization.outbound.usage.limit.exceeded":"Max outbound message usage exceeded.","request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},{"name":"prefetchConversationId","in":"query","description":"Indicates whether or not to prefetch conversationId","required":false,"type":"boolean","default":false},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","integration.has.ingestion.rule":"Facebook integration cannot be deleted with an existing ingestion rule associated to it. Remove associated ingestion rule before deleting integration."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","integration.has.ingestion.rule":"Instagram integration cannot be deleted with an existing ingestion rule associated to it. Remove associated ingestion rule before deleting integration."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","supported.content.in.use.sms":"The supported content profile is in use by an SMS 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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.","conversation.error.disallowed.transfer.destination":"Disallowed transfer 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/suggestions/feedback":{"post":{"tags":["Conversations"],"summary":"Suggestion feedback.","description":"Google Agent Assist offering within Genesys will no longer be supported","operationId":"postConversationSuggestionsFeedback","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"in":"body","name":"body","description":"SuggestionFeedback","required":true,"schema":{"$ref":"#/definitions/Feedback"}}],"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":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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-inin-requires-permissions":{"type":"ANY","permissions":["conversation:suggestionFeedback:add"]},"x-purecloud-method-name":"postConversationSuggestionsFeedback"}},"/api/v2/conversations/{conversationId}/suggestions":{"get":{"tags":["Conversations"],"summary":"Get all suggestions for a conversation.","description":"","operationId":"getConversationSuggestions","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation 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":"type","in":"query","description":"Suggestion type to filter by.","required":false,"type":"string","enum":["Faq","Article","KnowledgeArticle","KnowledgeSearch","CannedResponse","Script"]},{"name":"state","in":"query","description":"Suggestion state to filter Copilot suggestions.","required":false,"type":"string","enum":["Suggested","Accepted","Dismissed","Failed","Rated"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SuggestionListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:suggestion:view"]},"x-purecloud-method-name":"getConversationSuggestions"}},"/api/v2/conversations/{conversationId}/suggestions/{suggestionId}":{"get":{"tags":["Conversations"],"summary":"Get Suggestion.","description":"","operationId":"getConversationSuggestion","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"suggestionId","in":"path","description":"Suggestion ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Suggestion"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:suggestion:view"]},"x-purecloud-method-name":"getConversationSuggestion"}},"/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement":{"post":{"tags":["Conversations"],"summary":"Save an engagement on the suggestion.","description":"","operationId":"postConversationSuggestionEngagement","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"},{"name":"suggestionId","in":"path","description":"Suggestion ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SuggestionEngagement"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SuggestionEngagement"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:suggestionEngagement:add"]},"x-purecloud-method-name":"postConversationSuggestionEngagement"}},"/api/v2/conversations/{conversationId}/summaries":{"get":{"tags":["Conversations"],"summary":"Get the summaries of the conversation.","description":"","operationId":"getConversationSummaries","produces":["application/json"],"parameters":[{"name":"conversationId","in":"path","description":"Conversation ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ConversationSummariesGetResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:summary:view"]},"x-purecloud-method-name":"getConversationSummaries"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/dataprivacy/maskingrules/{ruleId}":{"get":{"tags":["Data Privacy"],"summary":"Fetch details about a masking rule.","description":"","operationId":"getDataprivacyMaskingrule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaskingRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"maskingrule.notfound":"No masking rule found for the ruleId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-privacy","data-privacy:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["dataprivacy:maskingrule:view"]},"x-purecloud-method-name":"getDataprivacyMaskingrule"},"delete":{"tags":["Data Privacy"],"summary":"Delete a masking rule.","description":"","operationId":"deleteDataprivacyMaskingrule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"}],"responses":{"204":{"description":"Masking 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":{"maskingrule.notfound":"No masking rule found for the ruleId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-privacy"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["dataprivacy:maskingrule:delete"]},"x-purecloud-method-name":"deleteDataprivacyMaskingrule"},"patch":{"tags":["Data Privacy"],"summary":"Update information about a masking rule.","description":"","operationId":"patchDataprivacyMaskingrule","produces":["application/json"],"parameters":[{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/MaskingRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaskingRule"}},"202":{"description":"Masking rule updated successfully","schema":{"$ref":"#/definitions/MaskingRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"maskingrule.maxlimit":"Maximum rule creation for associated integration channel reached.","regex.inefficient":"There exist a wild card character repition in regex which is not 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","regex.invalid":"Provided regex is not a valid regex, please correct and try again.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","regex.timeout":"Provided regex takes longer than expected. Please change the regex and try again.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"maskingrule.notfound":"No masking rule found for the ruleId.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","definition.conflict":"This mask shares the same regular expression and channel field with another mask. Please change details so they don't overlap."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-privacy"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["dataprivacy:maskingrule:edit"]},"x-purecloud-method-name":"patchDataprivacyMaskingrule"}},"/api/v2/dataprivacy/maskingrules":{"get":{"tags":["Data Privacy"],"summary":"Retrieve the list of masking rules.","description":"","operationId":"getDataprivacyMaskingrules","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaskingRuleListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"maskingrules.notfound":"No masking rule found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-privacy","data-privacy:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["dataprivacy:maskingrule:view"]},"x-purecloud-method-name":"getDataprivacyMaskingrules"},"post":{"tags":["Data Privacy"],"summary":"Create a new masking rule resource.","description":"","operationId":"postDataprivacyMaskingrules","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Details for creating masking rule resource","required":true,"schema":{"$ref":"#/definitions/MaskingRule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaskingRule"}},"201":{"description":"Masking rule created successfully","schema":{"$ref":"#/definitions/MaskingRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"maskingrule.maxlimit":"Maximum rule creation for associated integration channel reached.","regex.inefficient":"There exist a wild card character repition in regex which is not 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","regex.invalid":"Provided regex is not a valid regex, please correct and try again.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","regex.timeout":"Provided regex takes longer than expected. Please change the regex and try again.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","definition.conflict":"This mask shares the same regular expression and channel field with another mask. Please change details so they don't overlap."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-privacy"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["dataprivacy:maskingrule:add"]},"x-purecloud-method-name":"postDataprivacyMaskingrules"}},"/api/v2/dataprivacy/maskingrules/validate":{"post":{"tags":["Data Privacy"],"summary":"Validate masking before creating.","description":"","operationId":"postDataprivacyMaskingrulesValidate","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Text to be masked","required":true,"schema":{"$ref":"#/definitions/MaskingRuleValidateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/MaskingRuleValidateResponse"}},"202":{"description":"Masking rule validated successfully.","schema":{"$ref":"#/definitions/MaskingRuleValidateResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"422":{"schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"regex.invalid":"Provided regex is not a valid regex, please correct and try again."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-privacy"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["dataprivacy:maskingrule:execute"]},"x-purecloud-method-name":"postDataprivacyMaskingrulesValidate"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"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.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","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","flows.datatables.table.not.found":"The specified datatable was not found.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","outbound:campaign:recycle"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"patch":{"tags":["Outbound"],"summary":"Update a campaign.","description":"","operationId":"patchOutboundCampaign","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"},{"in":"body","name":"body","description":"CampaignPatchRequest","required":true,"schema":{"$ref":"#/definitions/CampaignPatchRequest"}}],"responses":{"204":{"description":"The campaign 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":{"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.max.calls.per.agent":"Max calls per agent must be inside allowed range","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.update":"An attempt was made to update the outbound campaign in an invalid 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.","queue.not.found":"The queue could not be found.","resources.in.use":"Resources are already in use.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","invalid.update.wrong.version":"Conflict due to concurrent modification was detected"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"patchOutboundCampaign"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/campaigns/{campaignId}/skillcombinations":{"get":{"tags":["Outbound"],"summary":"Get the remaining and total contact count for each skill combination in a skills campaign","description":"","operationId":"getOutboundCampaignSkillcombinations","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign 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/PagedSkillCombinationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"getOutboundCampaignSkillcombinations"}},"/api/v2/outbound/campaigns/{campaignId}/start":{"post":{"tags":["Outbound"],"summary":"Start the campaign","description":"","operationId":"postOutboundCampaignStart","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"OK - The campaign is started"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:start"]},"x-purecloud-method-name":"postOutboundCampaignStart"}},"/api/v2/outbound/campaigns/{campaignId}/stop":{"post":{"tags":["Outbound"],"summary":"Stop the campaign","description":"","operationId":"postOutboundCampaignStop","produces":["application/json"],"parameters":[{"name":"campaignId","in":"path","description":"Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"OK - The campaign is stopped"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:stop"]},"x-purecloud-method-name":"postOutboundCampaignStop"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.","conditions.limit.exceeded":"The maximum number of conditions has been exceeded","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.","cannot.modify.campaign.rule.property":"Cannot modify a rule property","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.","invalid.campaign.rule.action.parameter.messages.per.minute":"Parameter messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for messaging campaign type (see documentation)","invalid.campaign.rule.property.value":"Invalid a campaign rule property 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","campaign.rule.entity.incompatible":"Incompatible rule entities","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.","conditions.limit.exceeded":"The maximum number of conditions has been exceeded","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.","invalid.campaign.rule.action.parameter.messages.per.minute":"Parameter messages per minute must be provided, and must be an integer between 1 and the maximum allowable messages per minute for messaging campaign type (see documentation)","invalid.campaign.rule.property.value":"Invalid a campaign rule property 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.dialing.mode.update":"Invalid dialing mode specified.","campaign.rule.entity.incompatible":"Incompatible rule entities","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.interval.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 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":"","invalid.update":"An attempt was made to update the 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.attributes.supplied":"The schedule contains unsupported attributes","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","recurrence.alterations.exceeded.limit":"The number of alterations within the recurrence has exceeded the limit","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 must be 'campaigns'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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/jobs/{jobId}":{"get":{"tags":["Outbound"],"summary":"Get bulk operation job.","description":"","operationId":"getOutboundContactlistContactsBulkJob","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"},{"name":"jobId","in":"path","description":"Job ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","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":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"getOutboundContactlistContactsBulkJob"}},"/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs":{"get":{"tags":["Outbound"],"summary":"Get 10 most recent bulk operation jobs associated with contact list.","description":"","operationId":"getOutboundContactlistContactsBulkJobs","produces":["application/json"],"parameters":[{"name":"contactListId","in":"path","description":"Contact List ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ContactsBulkOperationJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"getOutboundContactlistContactsBulkJobs"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.","invalid.interval.time":"","bad.request":"The request could not be understood by the server due to malformed syntax.","duplicate.name":"The name already exists.","invalid.create":"An attempt was made to create the 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.","campaign.sequence.missing.campaign":"The dialer campaign sequence is missing the campaign.","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","campaign.sequence.cannot.add.running.campaign.to.on.sequence":"","campaign.sequence.cannot.remove.running.campaign":"","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":"","invalid.update":"An attempt was made to update the schedule in an invalid way","invalid.alteration.type":"The alteration type is a required field and must be a valid alteration type.","campaign.sequence.invalid.current.campaign":"Current campaign is invalid","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.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","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.attributes.supplied":"The schedule contains unsupported attributes","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","recurrence.alterations.exceeded.limit":"The number of alterations within the recurrence has exceeded the limit","campaign.sequence.invalid.campaign":"At least one campaign is invalid","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\"","campaign.sequence.is.empty":"The dialer campaign sequence is empty.","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 must be 'sequences'"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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.","campaign.not.found":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","sequence.not.found":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","business.categories.mutually.exclusive":"Business categories are mutually exclusive","business.categories.rpc.required":"Business category requires Right_Party_Contact flag","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"invalid.column.data.type.specification.data.type":"Column data type specification data type must match the contact sort column data type","email.reply.to.address.domain.not.found":"The reply-to address domain could not be found","contact.list.not.found":"The contact list could not be found","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)","cannot.update.campaign.type":"The campaign type cannot be updated to a different type configuration","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.contact.list":"A valid contact list must be provided","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","invalid.message.column":"The message column must be provided, and must be a valid column on the selected contact list","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","invalid.dnc.list":"One or more DNC List references are invalid","email.content.template.not.authorized":"The user does not have authorization to access the content template","email.reply.to.address.route.not.found":"The reply-to address route could not be found","bad.request":"The request could not be understood by the server due to malformed syntax.","invalid.callable.time.set":"The provided callable time set is invalid","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)","invalid.phone.column":"The phone column must be provided, and must be a valid column on the selected contact list","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","client.failed.request":"The 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.filter.mismatch":"The contact list on the contact list filter does not match the one on the campaign","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","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.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","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","sms.content.template.mms.phone.number.type.not.supported":"The Content template with mms is not supported for the sms phone number type","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.","missing.time.zone.in.contactlist":"When using a callable time set, the contact list must have at least one time zone column defined","invalid.type.config":"Exactly one of [emailConfig, smsConfig] must be provided","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","duplicate.name":"The name is in use by another messaging campaign","invalid.email.reply.to.address.route.domain":"The reply-to address route must have a reply route domain configured","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.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","invalid.response.asset.type":"The asset type on the response must be valid for the supported content profile configured on the phone number.","invalid.name":"A name must be provided","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","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.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","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.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","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","sms.content.template.mms.not.supported":"The Content template with mms is not supported for the sms phone number","callable.time.set.not.found":"The callable time set could not be found","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)","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.email.content.template.texts":"The content template must contain exactly two response texts","dynamic.queueing.campaigns.count.exceeded":"The limit for dynamic queueing campaigns has been exceeded","sms.content.template.not.found":"The Content template could not be found","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","missing.phone.columns.in.contactlist":"The contact list must have at least one phone number column configured when the campaign is configured for SMS","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","email.content.template.not.found":"The content template could not be found","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.not.authorized":"User doesn't have authorization to access content template","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of 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":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"Documented permissions are applicable based on campaign type.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","outbound:messagingCampaign:recycle","outbound:emailCampaign:recycle"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/{messagingCampaignId}/start":{"post":{"tags":["Outbound"],"summary":"Start the campaign","description":"Documented permissions are applicable based on campaign type.","operationId":"postOutboundMessagingcampaignStart","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"OK - The campaign is started"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:start","outbound:emailCampaign:start"]},"x-purecloud-method-name":"postOutboundMessagingcampaignStart"}},"/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/stop":{"post":{"tags":["Outbound"],"summary":"Stop the campaign","description":"Documented permissions are applicable based on campaign type.","operationId":"postOutboundMessagingcampaignStop","produces":["application/json"],"parameters":[{"name":"messagingCampaignId","in":"path","description":"The Messaging Campaign ID","required":true,"type":"string"}],"responses":{"204":{"description":"OK - The campaign is stopped"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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:stop","outbound:emailCampaign:stop"]},"x-purecloud-method-name":"postOutboundMessagingcampaignStop"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.response.asset.type":"The asset type on the response must be valid for the supported content profile configured on the phone number.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.attributes.supplied":"The schedule contains unsupported attributes","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","recurrence.alterations.exceeded.limit":"The number of alterations within the recurrence has exceeded the limit","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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.attributes.supplied":"The schedule contains unsupported attributes","invalid.days.of.week":"The daysOfWeek field is required for weekly recurrence patterns and must be valid days of the week.","recurrence.alterations.exceeded.limit":"The number of alterations within the recurrence has exceeded the limit","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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":{"general.resource.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 update group configuration due to invalid request.","invalid.property":"Value [%s] is not a valid property for object [%s]","invalid.standalone.phone":"Phone ID provided does not exist or is not standalone.","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","x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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]","invalid.standalone.phone":"Phone ID provided does not exist or is not standalone.","group.name.in.use":"This group name is currently in use.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings"]},"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","general.bad.request":"Unable to find the user profile 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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":{"ocelot.not.found":"Ocelot not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/certificates/truststore":{"get":{"tags":["Integrations"],"summary":"Retrieves basic info about trusted root CA certificates","description":"","operationId":"getIntegrationsActionsCertificatesTruststore","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrustedCertificates"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getIntegrationsActionsCertificatesTruststore"}},"/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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"flatten","in":"query","description":"Indicates the response should be reformatted, based on Architect's flattening format.","required":false,"type":"boolean","default":false}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/audioconnector/{integrationId}":{"get":{"tags":["Integrations"],"summary":"Get an Audio Connector integration","description":"","operationId":"getIntegrationsSpeechAudioconnectorIntegrationId","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"The integration ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AudioConnectorIntegration"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getIntegrationsSpeechAudioconnectorIntegrationId"}},"/api/v2/integrations/speech/audioconnector":{"get":{"tags":["Integrations"],"summary":"Get a list of Audio Connector integrations","description":"","operationId":"getIntegrationsSpeechAudioconnector","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/AudioConnectorIntegrationEntityListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getIntegrationsSpeechAudioconnector"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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"},{"name":"eventType","in":"query","description":"A comma separated list of journey event types to include in the results.","required":false,"type":"string","enum":["com.genesys.journey.OutcomeAchievedEvent","com.genesys.journey.SegmentAssignmentEvent","com.genesys.journey.WebActionEvent","com.genesys.journey.WebEvent","com.genesys.journey.AppEvent"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyView"},"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":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:delete"]},"x-purecloud-method-name":"deleteJourneyView"}},"/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":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViewVersion"},"put":{"tags":["Journey"],"summary":"Update a Journey View by ID and version","description":"does not create a new version","operationId":"putJourneyViewVersion","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"name":"versionId","in":"path","description":"versionId","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":{"limit.exceeded":"Body content has exceeded the authorized limit","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","malformed.value":"Some content of body contains malformed value","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","not.allowed":"Some content of body is not allowed","blocked":"The request is blocked for your organization","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","request.invalidates.job.results":"The request invalidates the job results for this journey id version.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client 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":"Some content of body contains 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":{"entity.not.found":"The journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":{"external.query.failure":"The request to external 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":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:edit"]},"x-purecloud-method-name":"putJourneyViewVersion"}},"/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":{"limit.exceeded":"Body content has exceeded the authorized limit","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","malformed.value":"Some content of body contains malformed value","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","not.allowed":"Some content of body is not allowed","blocked":"The request is blocked for your organization","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client 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":"Some content of body contains 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":{"entity.not.found":"The journey was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":{"external.query.failure":"The request to external 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":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:edit"]},"x-purecloud-method-name":"postJourneyViewVersions"}},"/api/v2/journey/views":{"get":{"tags":["Journey"],"summary":"Get a list of Journey Views","description":"","operationId":"getJourneyViews","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":"nameOrCreatedBy","in":"query","description":"Journey View Name or Created By","required":false,"type":"string"},{"name":"expand","in":"query","description":"Parameter to request additional data to return in Journey payload","required":false,"type":"string","enum":["charts"]},{"name":"id","in":"query","description":"Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.","required":false,"type":"string"}],"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":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","limit.exceeded":"Query parameter has exceed the authorize 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]","response.too.large":"The payload of the response is too large","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViews"},"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":{"missing.required":"Some headers or the body of the request are missing","limit.exceeded":"Body content has exceeded the authorized limit","bad.request":"The request could not be understood by the server due to malformed syntax.","malformed.value":"Some content of body contains malformed value","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","not.allowed":"Some content of body is not allowed","blocked":"The request is blocked for your organization","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client 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":"Some content of body contains 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":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":{"external.query.failure":"The request to external 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":["journey"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:add"]},"x-purecloud-method-name":"postJourneyViews"}},"/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}":{"get":{"tags":["Journey"],"summary":"Get a Chart by ID and version","description":"","operationId":"getJourneyViewVersionChartVersion","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"name":"journeyViewVersion","in":"path","description":"Journey View Version","required":true,"type":"string"},{"name":"chartId","in":"path","description":"chartId","required":true,"type":"string"},{"name":"chartVersion","in":"path","description":"chartVersion","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewChart"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey or chart was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViewVersionChartVersion"}},"/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}":{"get":{"tags":["Journey"],"summary":"Get a Chart by ID","description":"returns the latest version","operationId":"getJourneyViewVersionChart","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"viewId","required":true,"type":"string"},{"name":"journeyViewVersion","in":"path","description":"Journey View Version","required":true,"type":"string"},{"name":"chartId","in":"path","description":"chartId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewChart"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"blocked":"The request is blocked for your organization","missing.required":"Some headers or the body of the request are missing","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 journey or chart was not found in database","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","transaction.conflict":"Database raises transaction 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":["journey","journey:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["journey:views:view"]},"x-purecloud-method-name":"getJourneyViewVersionChart"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest":{"get":{"tags":["Journey"],"summary":"Get the latest job of a journey view version.","description":"","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}":{"get":{"tags":["Journey"],"summary":"Get the job for a journey view version.","description":"","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]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"patch":{"tags":["Journey"],"summary":"Update the job for a journey view version. Only the status can be changed and only to Cancelled","description":"","operationId":"patchJourneyViewVersionJob","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"},{"in":"body","name":"body","description":"journeyViewJob","required":true,"schema":{"$ref":"#/definitions/JourneyViewJob"}}],"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","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:edit"]},"x-purecloud-method-name":"patchJourneyViewVersionJob"}},"/api/v2/journey/views/jobs":{"get":{"tags":["Journey"],"summary":"Get the jobs for an organization.","description":"","operationId":"getJourneyViewsJobs","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"The number of the page to return","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max number of entities to return","required":false,"type":"integer","default":25,"format":"int32"},{"name":"interval","in":"query","description":"An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.","required":false,"type":"string","format":"interval","x-example":"2023-07-17T00:00:00Z/2023-07-18T00:00:00Z"},{"name":"statuses","in":"query","description":"Job statuses to filter for","required":false,"type":"string","x-example":"statuses=Accepted,Executing,Complete,Failed"}],"responses":{"200":{"description":"Request completed successfully","schema":{"$ref":"#/definitions/JourneyViewJobListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getJourneyViewsJobs"}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs":{"post":{"tags":["Journey"],"summary":"Submit a job request for a journey view version.","description":"","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}":{"get":{"tags":["Journey"],"summary":"Get the chart result associated with a journey view job.","description":"","operationId":"getJourneyViewVersionJobResultsChart","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"},{"name":"chartId","in":"path","description":"ChartId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewChartResult"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getJourneyViewVersionJobResultsChart"}},"/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":"","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/api/v2/journey/views/schedules":{"get":{"tags":["Journey"],"summary":"Get the journey schedules for an organization.","description":"","operationId":"getJourneyViewsSchedules","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"The number of the page to return","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"Max number of entities to return","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"Request completed successfully","schema":{"$ref":"#/definitions/JourneyViewScheduleListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:view"]},"x-purecloud-method-name":"getJourneyViewsSchedules"}},"/api/v2/journey/views/{viewId}/schedules":{"get":{"tags":["Journey"],"summary":"Get the Schedule for a JourneyView","description":"","operationId":"getJourneyViewSchedules","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:view"]},"x-purecloud-method-name":"getJourneyViewSchedules"},"post":{"tags":["Journey"],"summary":"Add a new Schedule to a JourneyView","description":"","operationId":"postJourneyViewSchedules","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"in":"body","name":"body","description":"journeyViewSchedule","required":true,"schema":{"$ref":"#/definitions/JourneyViewSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"201":{"description":"Schedule created successfully.","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:add"]},"x-purecloud-method-name":"postJourneyViewSchedules"},"put":{"tags":["Journey"],"summary":"Update the Schedule for a JourneyView","description":"","operationId":"putJourneyViewSchedules","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"},{"in":"body","name":"body","description":"journeyViewSchedule","required":true,"schema":{"$ref":"#/definitions/JourneyViewSchedule"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:edit"]},"x-purecloud-method-name":"putJourneyViewSchedules"},"delete":{"tags":["Journey"],"summary":"Delete the Schedule of a JourneyView","description":"","operationId":"deleteJourneyViewSchedules","produces":["application/json"],"parameters":[{"name":"viewId","in":"path","description":"Journey View Id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/JourneyViewSchedule"}},"204":{"description":"Scheduling 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","custom.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":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:viewsSchedule:delete"]},"x-purecloud-method-name":"deleteJourneyViewSchedules"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/integrations/{integrationId}/options":{"get":{"tags":["Knowledge"],"summary":"Get sync options available for a knowledge-connect integration","description":"","operationId":"getKnowledgeIntegrationOptions","produces":["application/json"],"parameters":[{"name":"integrationId","in":"path","description":"Integration ID","required":true,"type":"string"},{"name":"knowledgeBaseIds","in":"query","description":"Narrowing down filtering option results by knowledge base.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeIntegrationOptionsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","third.party.unknown.host":"Request to third party service failed: unknown host.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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.integration":"The provided integration is not active.","constraint.validation":"%s","third.party.invalid.credentials":"Request to third party service failed: invalid 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.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one 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 or Credential not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"third.party.unexpected.error":"Request to third party service failed: unexpected error.","internal.dependency.error":"Internal dependency 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","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationOptions:view"]},"x-purecloud-method-name":"getKnowledgeIntegrationOptions"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/sources":{"get":{"tags":["Knowledge"],"summary":"Get Knowledge integration sources","description":"","operationId":"getKnowledgeKnowledgebaseSources","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"type","in":"query","description":"If specified, retrieves integration sources with specified integration type.","required":false,"type":"string","enum":["Salesforce","ServiceNow"]},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["lastsync"]},"collectionFormat":"multi"},{"name":"ids","in":"query","description":"If specified, retrieves integration sources with specified IDs.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"type":"array","items":{"$ref":"#/definitions/SourceBaseResponse"}}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseSources"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}":{"get":{"tags":["Knowledge"],"summary":"Get Salesforce Knowledge integration source","description":"","operationId":"getKnowledgeKnowledgebaseSourcesSalesforceSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source 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":["lastsync"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"Get Salesforce Knowledge integration source","schema":{"$ref":"#/definitions/SalesforceSourceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Salesforce source not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseSourcesSalesforceSourceId"},"put":{"tags":["Knowledge"],"summary":"Update Salesforce Knowledge integration source","description":"","operationId":"putKnowledgeKnowledgebaseSourcesSalesforceSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SalesforceSourceRequest"}}],"responses":{"200":{"description":"Salesforce Knowledge integration source updated","schema":{"$ref":"#/definitions/SalesforceSourceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source or Integration not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:edit"]},"x-purecloud-method-name":"putKnowledgeKnowledgebaseSourcesSalesforceSourceId"},"delete":{"tags":["Knowledge"],"summary":"Delete Salesforce Knowledge integration source","description":"","operationId":"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"}],"responses":{"204":{"description":"Salesforce Knowledge integration source 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":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseSourcesSalesforceSourceId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce/{sourceId}/sync":{"post":{"tags":["Knowledge"],"summary":"Start sync on Salesforce Knowledge integration source","description":"","operationId":"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"Another synchronization is already running for this source","schema":{"$ref":"#/definitions/SourceSyncResponse"}},"202":{"description":"Synchronization on Salesforce Knowledge integration source started","schema":{"$ref":"#/definitions/SourceSyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Manual synchronization limit exceeded."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source or Integration not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSourcesSalesforceSourceIdSync"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/salesforce":{"post":{"tags":["Knowledge"],"summary":"Create Salesforce Knowledge integration source","description":"","operationId":"postKnowledgeKnowledgebaseSourcesSalesforce","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/SalesforceSourceRequest"}}],"responses":{"200":{"description":"Salesforce Knowledge integration source created","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Number of sources limit exceeded."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one 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 or KnowledgeBase not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSourcesSalesforce"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}":{"get":{"tags":["Knowledge"],"summary":"Get ServiceNow Knowledge integration source","description":"","operationId":"getKnowledgeKnowledgebaseSourcesServicenowSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source 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":["lastsync"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"Get ServiceNow Knowledge integration source","schema":{"$ref":"#/definitions/ServiceNowSourceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"ServiceNow source not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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","knowledge:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseSourcesServicenowSourceId"},"put":{"tags":["Knowledge"],"summary":"Update ServiceNow Knowledge integration source","description":"","operationId":"putKnowledgeKnowledgebaseSourcesServicenowSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ServiceNowSourceRequest"}}],"responses":{"200":{"description":"ServiceNow Knowledge integration source updated","schema":{"$ref":"#/definitions/ServiceNowSourceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source or Integration not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:edit"]},"x-purecloud-method-name":"putKnowledgeKnowledgebaseSourcesServicenowSourceId"},"delete":{"tags":["Knowledge"],"summary":"Delete ServiceNow Knowledge integration source","description":"","operationId":"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"}],"responses":{"204":{"description":"ServiceNow Knowledge integration source 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":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseSourcesServicenowSourceId"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow/{sourceId}/sync":{"post":{"tags":["Knowledge"],"summary":"Start synchronization on ServiceNow Knowledge integration source","description":"","operationId":"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"sourceId","in":"path","description":"Source ID","required":true,"type":"string"}],"responses":{"200":{"description":"Another sync is already running for this source","schema":{"$ref":"#/definitions/SourceSyncResponse"}},"202":{"description":"Synchronization on ServiceNow Knowledge integration source started","schema":{"$ref":"#/definitions/SourceSyncResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Manual synchronization limit exceeded."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"Source or Integration not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:edit"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSourcesServicenowSourceIdSync"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/sources/servicenow":{"post":{"tags":["Knowledge"],"summary":"Create ServiceNow Knowledge integration source","description":"","operationId":"postKnowledgeKnowledgebaseSourcesServicenow","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/ServiceNowSourceRequest"}}],"responses":{"200":{"description":"ServiceNow Knowledge integration source created","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"Input parameters do not match the required criteria.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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 provided integration is not active.","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s","limit.reached":"Number of sources limit exceeded."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one 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 or KnowledgeBase not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.dependency.error":"Internal dependency 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"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["knowledge:integrationSource:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSourcesServicenow"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"Daily or monthly upload limit exceeded.","x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/answers":{"post":{"tags":["Knowledge"],"summary":"Answer documents.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsAnswers","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/KnowledgeDocumentsAnswerFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeAnswerDocumentsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","knowledge:documentAnswer:view"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseDocumentsAnswers"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/KnowledgeDocumentCreateRequest"}}],"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"]},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["contentUrl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/DocumentVariationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationResponse"}},"400":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]},{"name":"expand","in":"query","description":"The specified entity attributes will be filled. Comma separated values expected.","required":false,"type":"array","items":{"type":"string","enum":["contentUrl"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationResponseListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/DocumentVariationRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/DocumentVariationResponse"}},"400":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"patch":{"tags":["Knowledge"],"summary":"Update feedback on a document","description":"","operationId":"patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId","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"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/KnowledgeDocumentFeedbackUpdateRequest"}}],"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","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/documents/query":{"post":{"tags":["Knowledge"],"summary":"Query for knowledge documents.","description":"","operationId":"postKnowledgeKnowledgebaseDocumentsQuery","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/KnowledgeDocumentQuery"}},{"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","knowledgeBaseLanguageCode"]},"collectionFormat":"multi"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeDocumentQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"postKnowledgeKnowledgebaseDocumentsQuery"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/synchronize/jobs/{syncJobId}":{"get":{"tags":["Knowledge"],"summary":"Get synchronization job report","description":"","operationId":"getKnowledgeKnowledgebaseSynchronizeJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"syncJobId","in":"path","description":"Synchronization job ID","required":true,"type":"string"}],"responses":{"200":{"description":"Get synchronization job","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:syncJob:view"]},"x-purecloud-method-name":"getKnowledgeKnowledgebaseSynchronizeJob"},"delete":{"tags":["Knowledge"],"summary":"Delete synchronization job","description":"","operationId":"deleteKnowledgeKnowledgebaseSynchronizeJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"syncJobId","in":"path","description":"Synchronization job ID","required":true,"type":"string"}],"responses":{"204":{"description":"Synchronization 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:syncJob:delete"]},"x-purecloud-method-name":"deleteKnowledgeKnowledgebaseSynchronizeJob"},"patch":{"tags":["Knowledge"],"summary":"Update synchronization job","description":"","operationId":"patchKnowledgeKnowledgebaseSynchronizeJob","produces":["application/json"],"parameters":[{"name":"knowledgeBaseId","in":"path","description":"Knowledge base ID","required":true,"type":"string"},{"name":"syncJobId","in":"path","description":"Synchronization job ID","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/SyncStatusRequest"}}],"responses":{"202":{"description":"Synchronization job updated","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:syncJob:edit"]},"x-purecloud-method-name":"patchKnowledgeKnowledgebaseSynchronizeJob"}},"/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/synchronize/jobs":{"post":{"tags":["Knowledge"],"summary":"Create synchronization job","description":"","operationId":"postKnowledgeKnowledgebaseSynchronizeJobs","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/KnowledgeSyncJobRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"202":{"description":"Synchronization job in progress","schema":{"$ref":"#/definitions/KnowledgeSyncJobResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:syncJob:add"]},"x-purecloud-method-name":"postKnowledgeKnowledgebaseSynchronizeJobs"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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","knowledgeBaseLanguageCode"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/namespaces/{namespaceName}/limits/{limitName}/counts":{"get":{"tags":["Organization"],"summary":"Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.","description":"See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).","operationId":"getOrganizationsLimitsNamespaceLimitCounts","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to get","required":true,"type":"string"},{"name":"limitName","in":"path","description":"The limit to get","required":true,"type":"string"},{"name":"entityId","in":"query","description":"entity id of the count","required":false,"type":"string"},{"name":"userId","in":"query","description":"userid of the count","required":false,"type":"string"},{"name":"cursor","in":"query","description":"Cursor provided when retrieving the last page","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitCountListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:count:view"]},"x-purecloud-method-name":"getOrganizationsLimitsNamespaceLimitCounts"}},"/api/v2/organizations/limits/namespaces/{namespaceName}/counts":{"get":{"tags":["Organization"],"summary":"Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking.","description":"See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).","operationId":"getOrganizationsLimitsNamespaceCounts","produces":["application/json"],"parameters":[{"name":"namespaceName","in":"path","description":"The namespace to get","required":true,"type":"string"},{"name":"cursor","in":"query","description":"Cursor provided when retrieving the last page","required":false,"type":"string"},{"name":"entityId","in":"query","description":"entity id of the count","required":false,"type":"string"},{"name":"userId","in":"query","description":"userid of the count","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/LimitCountListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:count:view"]},"x-purecloud-method-name":"getOrganizationsLimitsNamespaceCounts"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","supported.content.in.use.sms":"The supported content profile is in use by an SMS 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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","forbidden":"Forbidden from sending a journey app event.","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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/journey/deployments/{deploymentId}/webevents":{"post":{"tags":["Journey"],"summary":"Send a journey web event, used for tracking customer activity on a website.","description":"","operationId":"postJourneyDeploymentWebevents","produces":["application/json"],"parameters":[{"name":"deploymentId","in":"path","description":"The ID of the deployment sending the web event.","required":true,"type":"string"},{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/WebEventRequest"}}],"responses":{"200":{"description":"Request completed successfully.","schema":{"$ref":"#/definitions/WebEventResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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 web 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":"postJourneyDeploymentWebevents"}},"/api/v2/knowledge/guest/sessions/{sessionId}/documents/answers":{"post":{"tags":["Knowledge"],"summary":"Answer documents.","description":"","operationId":"postKnowledgeGuestSessionDocumentsAnswers","produces":["application/json"],"parameters":[{"name":"sessionId","in":"path","description":"Knowledge guest session ID.","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/KnowledgeDocumentsAnswerFilter"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/KnowledgeGuestAnswerDocumentsResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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":"postKnowledgeGuestSessionDocumentsAnswers"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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","knowledgeBaseLanguageCode"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"chat.error.service.unavailable":"Chat service 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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 from 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":{"not.found":"The requested resource was not found.","wfm.external.calendar.entity.not.found":"The requested calendar 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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).","notification.unauthorized.divisioned.topic":"No divisioned permissions for this topic.","app.not.authorized.for.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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).","notification.unauthorized.divisioned.topic":"No divisioned permissions for this topic.","app.not.authorized.for.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":{"entity.not.found":"Subscription list not found.","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/usage/events/query":{"post":{"tags":["Operational Events"],"summary":"Query operational events in a timeframe.","description":"","operationId":"postUsageEventsQuery","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/EventQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventQueryResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"usage.events.too.old":"The requested interval doesn't contain any events because it's too far in the past","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"postUsageEventsQuery"}},"/api/v2/usage/events/aggregates/query":{"post":{"tags":["Operational Events"],"summary":"Get aggregates for operational events in a timeframe.","description":"","operationId":"postUsageEventsAggregatesQuery","produces":["application/json"],"parameters":[{"in":"body","name":"body","required":false,"schema":{"$ref":"#/definitions/EventAggregatesQueryRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/EventAggregatesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"usage.events.too.old":"The requested interval doesn't contain any events because it's too far in the past","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"postUsageEventsAggregatesQuery"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/trustees/care":{"get":{"tags":["Organization Authorization"],"summary":"Get Customer Care organization ids.","description":"","operationId":"getOrgauthorizationTrusteesCare","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/TrusteeReferenceList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getOrgauthorizationTrusteesCare"},"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":"postOrgauthorizationTrusteesCare","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"},{"name":"assignFullAccess","in":"query","description":"Grant Customer Care full access to the organization","required":false,"type":"boolean"},{"name":"allowTrustedUserAccess","in":"query","description":"Make Customer Care a Trusted User","required":false,"type":"boolean"}],"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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"postOrgauthorizationTrusteesCare"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","enum":["all","call","chat","callback","email","videoComm","message"]},{"name":"labelId","in":"query","description":"Unique id that represents the interaction label used with media type for EWT calculation","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 requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization 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: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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.organizationconfiguration.invalidrestoretimemilliseconds":"Restore time value out of bounds","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"presenceservice.source.namecannotbeblank":"A name must be provided for a source","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"userState","in":"query","description":"'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. \n'Any' fetches users of 'active', 'inactive' and 'deleted' states.","required":false,"type":"string","default":"Legacy","enum":["Any","Legacy"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"expand","in":"query","description":"variable name requested by expand list","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"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"},{"name":"includeDeletedUsers","in":"query","description":"Allow returning an agent or evaluator user with a 'delete' status. Defaults to false.","required":false,"type":"boolean","default":false}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"general.internal.server.error":"An internal server 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":["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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"general.internal.server.error":"An internal server 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":["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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"general.internal.server.error":"An internal server 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":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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-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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","recording:settings:editRegionalStorage","recording:settings:editUrlExpiration"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"This API is deprecated and the functionality to stop screen recording will be no longer supported.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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"]}],"deprecated":true,"x-inin-requires-permissions":{"type":"ANY","permissions":["recording:screenRecording:stop"]},"x-purecloud-method-name":"patchRecordingsScreensession"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","composer.form.path.invalid.format":"Evaluation form path format 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","rms.field.exceeds.max.length":"Field exceeds max length","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization 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: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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"skillsservice.skillnotfound":"The Skill 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"skillsservice.skillnotfound":"The Skill 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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]","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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]","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","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 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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]","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.domain.not.found":"The domain could not be 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.domain.not.found":"The domain could not be 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Route update completed.","schema":{"$ref":"#/definitions/InboundRoute"}},"202":{"description":"Accepted - route update in progress.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Route deletion completed."},"202":{"description":"Delete in progress.","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"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Route create completed.","schema":{"$ref":"#/definitions/InboundRoute"}},"202":{"description":"Accepted - route creation in progress.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","whatsapp","open","instagram","apple"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/{phoneNumberId}":{"get":{"tags":["Routing"],"summary":"Get a phone number provisioned for SMS.","description":"","operationId":"getRoutingSmsPhonenumber","produces":["application/json"],"parameters":[{"name":"phoneNumberId","in":"path","description":"phone number","required":true,"type":"string"},{"name":"expand","in":"query","description":"Expand response with additional information","required":false,"type":"string","enum":["compliance","supportedContent"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"phoneNumberId","in":"path","description":"phone number","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"phoneNumberId","in":"path","description":"phone number","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"},{"name":"supportedContent.id","in":"query","description":"Filter based on the supported content ID","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"division.authorization.timeout":"Division authorization 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/assistant":{"get":{"tags":["Routing"],"summary":"Get an assistant associated with a queue.","description":"","operationId":"getRoutingQueueAssistant","produces":["application/json"],"parameters":[{"name":"queueId","in":"path","description":"Queue ID","required":true,"type":"string"},{"name":"expand","in":"query","description":"Which fields, if any, to expand.","required":false,"type":"string","enum":["assistant"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AssistantQueue"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.request.timeout":"Authentication request timeout.","request.timeout":"The request timed out."}}},"security":[{"PureCloud OAuth":["assistants","assistants:readonly"]}],"x-inin-requires-permissions":{"type":"ALL","permissions":["assistants:queue:view"]},"x-purecloud-method-name":"getRoutingQueueAssistant"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/directroutingbackup/settings/me":{"get":{"tags":["Routing","Users"],"summary":"Get the user's Direct Routing Backup settings.","description":"","operationId":"getRoutingDirectroutingbackupSettingsMe","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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's backup settings 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:selfView"]},"x-purecloud-method-name":"getRoutingDirectroutingbackupSettingsMe"},"put":{"tags":["Routing","Users"],"summary":"Update the user's Direct Routing Backup settings.","description":"","operationId":"putRoutingDirectroutingbackupSettingsMe","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"directRoutingBackup","required":true,"schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:selfEdit"]},"x-purecloud-method-name":"putRoutingDirectroutingbackupSettingsMe"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.","description":"","operationId":"deleteRoutingDirectroutingbackupSettingsMe","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:selfDelete"]},"x-purecloud-method-name":"deleteRoutingDirectroutingbackupSettingsMe"}},"/api/v2/routing/users/{userId}/directroutingbackup/settings":{"get":{"tags":["Routing","Users"],"summary":"Get the user's Direct Routing Backup settings.","description":"","operationId":"getRoutingUserDirectroutingbackupSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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 user's backup settings 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:view"]},"x-purecloud-method-name":"getRoutingUserDirectroutingbackupSettings"},"put":{"tags":["Routing","Users"],"summary":"Update the user's Direct Routing Backup settings.","description":"","operationId":"putRoutingUserDirectroutingbackupSettings","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"User ID","required":true,"type":"string"},{"in":"body","name":"body","description":"directRoutingBackup","required":true,"schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}}],"responses":{"200":{"description":"Operation was successful.","schema":{"$ref":"#/definitions/AgentDirectRoutingBackupSettings"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. 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":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:edit"]},"x-purecloud-method-name":"putRoutingUserDirectroutingbackupSettings"},"delete":{"tags":["Routing","Users"],"summary":"Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.","description":"","operationId":"deleteRoutingUserDirectroutingbackupSettings","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","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."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:directRoutingBackup:delete"]},"x-purecloud-method-name":"deleteRoutingUserDirectroutingbackupSettings"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","resource.not.found":"A referenced resource, such as a division, was not 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":"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."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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:enterprise:2.0:User:dateHire","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:enterprise:2.0:User:dateHire","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"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":"Version does not match current version.","schema":{"$ref":"#/definitions/ScimError"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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:enterprise:2.0:User:dateHire","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:enterprise:2.0:User:dateHire","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{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:enterprise:2.0:User:dateHire","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:enterprise:2.0:User:dateHire","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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:enterprise:2.0:User:dateHire","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:enterprise:2.0:User:dateHire","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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","externalContactsSettings","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","transcription","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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","externalContactsSettings","profileSkills","certifications","locations","groups","skills","languages","languagePreference","employerInfo","biography","dateLastLogin","callerUser.routingStatus","callerUser.primaryPresence","callerUser.conversationSummary","callerUser.outOfOffice","callerUser.geolocation","conversations","transcription","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"200 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"publish.programs.unpublished.topic.links.limit.exceeded":"Publishing programs with more than 500 unpublished topics is not allowed. Please publish the topics separately and try again."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"202":{"description":"The program was updated successfully, the topic links are being processed","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","topics.per.dialect.per.program.limit.exceeded":"500 topics per dialect per program 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":{"202":{"description":"The program was deleted successfully, the topic links are being deleted","schema":{"$ref":"#/definitions/DeleteProgramResponse"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"}},"202":{"description":"The program was created successfully, the topic links are being processed","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","topics.per.dialect.per.program.limit.exceeded":"500 topics per dialect per program 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"topics.per.dialect.per.program.limit.exceeded":"500 topics per dialect per program quota exceeded","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"}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"linked.programs.limit.exceeded":"10 linked programs limit exceeded. Try linking the topic using program update api."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":{"topics.per.dialect.per.program.limit.exceeded":"500 topics per dialect per program quota exceeded","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.","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":{"linked.programs.limit.exceeded":"10 linked programs limit exceeded. Try linking the topic using program update api."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"405":{"description":"Method Not Allowed","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.supported.above.500.topics":"Unpublished programs is not supported 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"},{"name":"expand","in":"query","description":"Expand the division name","required":false,"type":"string","enum":["entities.division"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/alertablepresences":{"get":{"tags":["Telephony Providers Edge"],"summary":"Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no overrides, it is the default list.","description":"","operationId":"getTelephonyProvidersEdgesAlertablepresences","produces":["application/json"],"parameters":[{"name":"type","in":"query","required":false,"type":"string","enum":["defaults","overrides"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlertablePresences"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"alertablepresencesoverrides.duplicatesnotallowed":"The same value may not be specified more than once.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"A value was specified for the 'type' query parameter that did not equal 'defaults' or 'overrides'","invalid.property":"Value [%s] is not a valid property for object [%s]","alertablepresencesoverrides.invalidalertablepresence":"The specified presences are not valid system presences.","alertablepresencesoverrides.availablepresencenotspecified":"Overrides must include the 'Available' system presence.","constraint.validation":"%s","invalid.value":"Presence value was specified that does not exist in the OrganizationPresenceDefinition.SystemPresence enum."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:alertablePresences:view"]},"x-purecloud-method-name":"getTelephonyProvidersEdgesAlertablepresences"},"put":{"tags":["Telephony Providers Edge"],"summary":"Creates or updates alertable presences overrides.","description":"","operationId":"putTelephonyProvidersEdgesAlertablepresences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Alertable Presences Overrides","required":true,"schema":{"$ref":"#/definitions/AlertablePresences"}}],"responses":{"202":{"description":"Accepted - processing create/update"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"alertablepresencesoverrides.duplicatesnotallowed":"The same value may not be specified more than once.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","alertablepresencesoverrides.invalidalertablepresence":"The specified presences are not valid system presences.","alertablepresencesoverrides.availablepresencenotspecified":"Overrides must include the 'Available' system presence.","constraint.validation":"%s","invalid.value":"Presence value was specified that does not exist in the OrganizationPresenceDefinition.SystemPresence enum."}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:alertablePresences:edit"]},"x-purecloud-method-name":"putTelephonyProvidersEdgesAlertablepresences"},"delete":{"tags":["Telephony Providers Edge"],"summary":"Deletes alertable presences overrides.","description":"","operationId":"deleteTelephonyProvidersEdgesAlertablepresences","produces":["application/json"],"parameters":[],"responses":{"202":{"description":"Accepted - processing deletion"},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:alertablePresences:delete"]},"x-purecloud-method-name":"deleteTelephonyProvidersEdgesAlertablepresences"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["id","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/search":{"get":{"tags":["Telephony Providers Edge","Search"],"summary":"Search sites using the q64 value returned from a previous search","description":"","operationId":"getTelephonyProvidersEdgesSitesSearch","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/SitesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"getTelephonyProvidersEdgesSitesSearch"},"post":{"tags":["Telephony Providers Edge","Search"],"summary":"Search sites","description":"","operationId":"postTelephonyProvidersEdgesSitesSearch","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Search request options","required":true,"schema":{"$ref":"#/definitions/SiteSearchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/SitesSearchResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"Sites not found"}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":["telephony","telephony:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["telephony:plugin:all","telephony:sites:view"]},"x-purecloud-method-name":"postTelephonyProvidersEdgesSitesSearch"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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","GenesysDigitalBotFlow","GenesysVoiceSurveyFlow"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","organization","organization:readonly"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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"]}],"deprecated":true,"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/{recordingId}/transcoding":{"get":{"tags":["User Recordings"],"summary":"Download a user recording.","description":"","operationId":"getUserrecordingTranscoding","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"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-inin-requires-permissions":{"type":"ANY","permissions":["They are enforced by the backend"]},"x-purecloud-method-name":"getUserrecordingTranscoding"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/chats/me":{"get":{"tags":["Users"],"summary":"Get chats for a user","description":"","operationId":"getUsersChatsMe","produces":["application/json"],"parameters":[{"name":"excludeClosed","in":"query","description":"Whether or not to exclude closed chats","required":false,"type":"boolean"},{"name":"includePresence","in":"query","description":"Whether or not to include user presence","required":false,"type":"boolean"},{"name":"after","in":"query","description":"The key to start after","required":false,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ChatItemCursorListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","user:chats:view"]},"x-purecloud-method-name":"getUsersChatsMe"}},"/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","externalContactsSettings","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","autoanswersettings"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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"},"x-inin-error-codes":{"user.not.found.on.delete":"User not found on 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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["admin","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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":["admin","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":["admin","directory:organization:admin","directory:userPassword:edit"]},"x-purecloud-method-name":"postUserInvite"}},"/api/v2/users/{userId}/routinglanguages/{languageId}":{"delete":{"tags":["Users","Routing"],"summary":"Remove a routing language from a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 an assigned routing language's proficiency","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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 languages assigned to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign a routing language to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign multiple routing languages to a user. Max 50 routing languages in request body","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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 an assigned routing skill's proficiency","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":{"request.conflict":"The request conflicts with the current state of the target resource.","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 a routing skill from a 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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 assigned to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign a routing skill to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign multiple routing skills to a user, replacing any current assignments","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Assign multiple routing skills to a 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"general.internal.server.error":"An internal server 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":{"division.authorization.timeout":"Division authorization timed out.","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/{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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","userservice.station.providerlocationmissing":"The edge 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 to an edge"}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/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 delete station association 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.","userservice.station.notfound":"The Station 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.","required":false,"type":"array","items":{"type":"string","enum":["routingStatus","presence","integrationPresence","conversationSummary","outOfOffice","geolocation","station","authorization","lasttokenissued","authorization.unusedRoles","team","workPlanBidRanks","externalContactsSettings","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"division.authorization.timeout":"Division authorization timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/users/{userId}/messages":{"get":{"tags":["Voicemail"],"summary":"List voicemail messages","description":"","operationId":"getVoicemailUserMessages","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/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":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:voicemail:viewOther"]},"x-purecloud-method-name":"getVoicemailUserMessages"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"502":{"description":"Bad Gateway","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"externalservice.error":"External service 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":["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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/users/{userId}/mailbox":{"get":{"tags":["Voicemail"],"summary":"Get a user's mailbox information","description":"","operationId":"getVoicemailUserMailbox","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"userId","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":"You are not authorized to perform the requested action.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:mailbox:viewOther"]},"x-purecloud-method-name":"getVoicemailUserMailbox"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","transcription"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","transcription"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","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","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":{"archy.state.invalid.job.id":"Invalid job ID supplied.","bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. 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","archy.state.wrong.endpoint":"Only Publish jobs are accessible via this endpoint.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},{"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},{"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},{"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"architect.flow.outcome.already.exists":"A flow outcome with the specified name already exists.","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","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.","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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":"Get 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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.voice.flow.invalid.operation":"Cannot perform requested operation on a voice 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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.","architect.worktype.invalid.id":"The worktype ID is invalid.","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.","architect.org.invalid.id":"The org ID 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.","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.","architect.worktype.not.found":"Could not find the worktype."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","architect.flow.cannot.create.worktype.used.in.existing.flow":"Flow cannot be created because another Workitem flow already references the same Worktype. You may only have one Workitem flow per Worktype.","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":{"architect.worktype.fetch.failed":"Failed to fetch the worktype.","internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request.","architect.flow.associate.worktype.failed":"Failed to associate flow with the worktype."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.flow.dissociate.worktype.failed":"Failed to dissociate flow with the worktype.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"}},"/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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"},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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).","architect.org.disabled.for.request":"Unable to get system prompt resource due to organization being disabled.","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.","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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"Filter by published status.","required":false,"type":"boolean"}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","flowDetails"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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","settings.notifications.scheduling","settings.learning","settings.coaching"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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","LongTermStaffing","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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","LongTermStaffing","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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","LongTermStaffing","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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}/agents/workplans/query":{"post":{"tags":["Workforce Management"],"summary":"Get agents work plans configuration","description":"","operationId":"postWorkforcemanagementManagementunitAgentsWorkplansQuery","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/GetAgentsWorkPlansRequest"}},{"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":"Success","schema":{"$ref":"#/definitions/AgentsWorkPlansResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlan:view"]},"x-purecloud-method-name":"postWorkforcemanagementManagementunitAgentsWorkplansQuery"}},"/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk":{"patch":{"tags":["Workforce Management"],"summary":"Updates agent work plan configuration","description":"","operationId":"patchWorkforcemanagementManagementunitAgentsWorkplansBulk","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/UpdateMuAgentWorkPlansBatchRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/UpdateMuAgentWorkPlansBatchResponse"}},"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/work plans not found in 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","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"patchWorkforcemanagementManagementunitAgentsWorkplansBulk"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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.","wfm.ids.may.not.be.blank":"One or more language, skill or queue 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","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The 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.too.many.skills.in.planning.group":"Too many skill IDs were passed across all route paths","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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.","wfm.ids.may.not.be.blank":"One or more language, skill or queue 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","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The 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.too.many.skills.in.planning.group":"Too many skill IDs were passed across all route paths","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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}/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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"}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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 week date of the initiating shift 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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 week date of the initiating shift 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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 week date of the initiating shift 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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 week date of the initiating shift 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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 week date of the initiating shift 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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 week date of the initiating shift 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/businessunits/{businessUnitId}/activityplans/jobs":{"get":{"tags":["Workforce Management"],"summary":"Gets the latest job for all activity plans in the business unit","description":"","operationId":"getWorkforcemanagementBusinessunitActivityplansJobs","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/ActivityPlanJobListing"}},"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":"Validation rules were violated on this 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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:activityPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivityplansJobs"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans":{"get":{"tags":["Workforce Management"],"summary":"Get activity plans","description":"","operationId":"getWorkforcemanagementBusinessunitActivityplans","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"state","in":"query","description":"Optionally filter by activity plan state","required":false,"type":"string","enum":["Active","Inactive"]}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanListing"}},"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":"Validation rules were violated on this 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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:activityPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivityplans"},"post":{"tags":["Workforce Management"],"summary":"Create an activity plan","description":"","operationId":"postWorkforcemanagementBusinessunitActivityplans","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":true,"schema":{"$ref":"#/definitions/CreateActivityPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanResponse"}},"201":{"description":"The activity plan was created successfully","schema":{"$ref":"#/definitions/ActivityPlanResponse"}},"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":"Validation rules were violated on this 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","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:activityPlan:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitActivityplans"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}":{"get":{"tags":["Workforce Management"],"summary":"Get an activity plan","description":"","operationId":"getWorkforcemanagementBusinessunitActivityplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"activityPlanId","in":"path","description":"The ID of the activity plan to fetch","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanResponse"}},"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":"Validation rules were violated on this 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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:activityPlan:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivityplan"},"patch":{"tags":["Workforce Management"],"summary":"Update an activity plan","description":"If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated","operationId":"patchWorkforcemanagementBusinessunitActivityplan","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"activityPlanId","in":"path","description":"The ID of the activity plan to update","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":true,"schema":{"$ref":"#/definitions/UpdateActivityPlanRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanResponse"}},"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":"Validation rules were violated on this 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","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:activityPlan:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitActivityplan"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs":{"post":{"tags":["Workforce Management"],"summary":"Run an activity plan manually","description":"Triggers a job running the activity plan. The activity plan cannot be updated until the job completes","operationId":"postWorkforcemanagementBusinessunitActivityplanRunsJobs","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"activityPlanId","in":"path","description":"The ID of the activity plan to run","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanJobResponse"}},"201":{"description":"The run activity plan job is running","schema":{"$ref":"#/definitions/ActivityPlanRunJobResponse"}},"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":"Validation rules were violated on this 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","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:activityPlanRunJob:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitActivityplanRunsJobs"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Gets an activity plan run job","description":"","operationId":"getWorkforcemanagementBusinessunitActivityplanRunsJob","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"activityPlanId","in":"path","description":"The ID of the activity plan associated with the run job","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The ID of the activity plan run job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ActivityPlanRunJobResponse"}},"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":"Validation rules were violated on this 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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:activityPlanRunJob:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitActivityplanRunsJob"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/businessunits/{businessUnitId}/alternativeshifts/settings":{"get":{"tags":["Workforce Management"],"summary":"Get alternative shifts settings for a business unit","description":"","operationId":"getWorkforcemanagementBusinessunitAlternativeshiftsSettings","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/AlternativeShiftBuSettingsResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitAlternativeshiftsSettings"},"patch":{"tags":["Workforce Management"],"summary":"Update alternative shifts settings for a business unit","description":"","operationId":"patchWorkforcemanagementBusinessunitAlternativeshiftsSettings","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/UpdateAlternativeShiftBuSettingsRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftBuSettingsResponse"}},"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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:businessUnit:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitAlternativeshiftsSettings"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search":{"post":{"tags":["Workforce Management"],"summary":"List alternative shifts trades for a given management unit or agent","description":"","operationId":"postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/SearchAlternativeShiftTradesRequest"}},{"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/BuListAlternativeShiftTradesResponse"}},"202":{"description":"The search trades request is processing","schema":{"$ref":"#/definitions/BuListAlternativeShiftTradesResponse"}},"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]","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","wfm.entity.not.found":"One of the requested resources in the request body 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:alternativeShift:view"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift search trade 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":"getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"jobId","in":"path","description":"The ID of the job","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/BuAlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:alternativeShift:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}":{"get":{"tags":["Workforce Management"],"summary":"Get an alternative shifts trade in a business unit for a given trade ID","description":"","operationId":"getWorkforcemanagementBusinessunitAlternativeshiftsTrade","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"tradeId","in":"path","description":"The ID of the alternative shift trade","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"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","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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:alternativeShift:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitAlternativeshiftsTrade"}},"/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift offers 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":"getWorkforcemanagementAlternativeshiftsOffersJob","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/AlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsOffersJob"}},"/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs":{"post":{"tags":["Workforce Management"],"summary":"Request a search of alternative shift offers for a given shift","description":"","operationId":"postWorkforcemanagementAlternativeshiftsOffersSearchJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AlternativeShiftSearchOffersRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"202":{"description":"The search offers request is processing","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"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.management.unit.not.found":"The requesting agent is not in a business or 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAlternativeshiftsOffersSearchJobs"}},"/api/v2/workforcemanagement/alternativeshifts/offers/jobs":{"post":{"tags":["Workforce Management"],"summary":"Request a list of alternative shift offers for a given schedule","description":"","operationId":"postWorkforcemanagementAlternativeshiftsOffersJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AlternativeShiftOffersRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"202":{"description":"The list offers request is processing","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"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.management.unit.not.found":"The requesting agent is not in a business or 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAlternativeshiftsOffersJobs"}},"/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift search offers 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":"getWorkforcemanagementAlternativeshiftsOffersSearchJob","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/AlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsOffersSearchJob"}},"/api/v2/workforcemanagement/alternativeshifts/trades":{"get":{"tags":["Workforce Management"],"summary":"Get a list of my alternative shifts trades","description":"","operationId":"getWorkforcemanagementAlternativeshiftsTrades","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"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/ListAlternativeShiftTradesResponse"}},"202":{"description":"The list trades request is processing","schema":{"$ref":"#/definitions/ListAlternativeShiftTradesResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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 requesting agent is not in a business or 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsTrades"},"post":{"tags":["Workforce Management"],"summary":"Create my alternative shift trade using an existing offer's jobId","description":"","operationId":"postWorkforcemanagementAlternativeshiftsTrades","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/CreateAlternativeShiftTradeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"201":{"description":"The requested trade was created","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"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.entity.not.found":"The requesting agent is not in a business or 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"postWorkforcemanagementAlternativeshiftsTrades"}},"/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift trades 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":"getWorkforcemanagementAlternativeshiftsTradesJob","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/AlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsTradesJob"}},"/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}":{"get":{"tags":["Workforce Management"],"summary":"Get my alternative shift trade by trade ID","description":"","operationId":"getWorkforcemanagementAlternativeshiftsTrade","produces":["application/json"],"parameters":[{"name":"tradeId","in":"path","description":"The ID of the alternative shift trade","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsTrade"},"patch":{"tags":["Workforce Management"],"summary":"Update my alternative shifts trade by trade ID","description":"","operationId":"patchWorkforcemanagementAlternativeshiftsTrade","produces":["application/json"],"parameters":[{"name":"tradeId","in":"path","description":"The ID of the alternative shift trade","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AgentUpdateAlternativeShiftTradeRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}},"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.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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"patchWorkforcemanagementAlternativeshiftsTrade"}},"/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs":{"patch":{"tags":["Workforce Management"],"summary":"Bulk update alternative shift trade states","description":"","operationId":"patchWorkforcemanagementAlternativeshiftsTradesStateJobs","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"The request body","required":true,"schema":{"$ref":"#/definitions/AdminBulkUpdateAlternativeShiftTradeStateRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"202":{"description":"The bulk update trade state request is processing","schema":{"$ref":"#/definitions/AlternativeShiftAsyncResponse"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:alternativeShift:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementAlternativeshiftsTradesStateJobs"}},"/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}":{"get":{"tags":["Workforce Management"],"summary":"Query the status of an alternative shift trade state 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":"getWorkforcemanagementAlternativeshiftsTradesStateJob","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/AlternativeShiftJobResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:alternativeShift:edit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsTradesStateJob"}},"/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":{"not.found":"The requested resource was not found.","wfm.external.calendar.entity.not.found":"The requested calendar 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":[],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/workplanbids":{"get":{"tags":["Workforce Management"],"summary":"Gets the list of work plan bids that belong to an agent","description":"","operationId":"getWorkforcemanagementWorkplanbids","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentWorkPlanBids"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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":"Agent work plan preference not found","not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentWorkPlanBid:submit"]},"x-purecloud-method-name":"getWorkforcemanagementWorkplanbids"}},"/api/v2/workforcemanagement/workplanbids/{bidId}/preferences":{"get":{"tags":["Workforce Management"],"summary":"Gets an agent's work plan bidding preference","description":"","operationId":"getWorkforcemanagementWorkplanbidPreferences","produces":["application/json"],"parameters":[{"name":"bidId","in":"path","description":"The ID of the work plan bid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentWorkPlanBiddingPreferenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentWorkPlanBid:submit"]},"x-purecloud-method-name":"getWorkforcemanagementWorkplanbidPreferences"},"patch":{"tags":["Workforce Management"],"summary":"Update an agent's work plan bidding preference","description":"","operationId":"patchWorkforcemanagementWorkplanbidPreferences","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/UpdateAgentWorkPlanBiddingPreference"}},{"name":"bidId","in":"path","description":"The ID of the work plan bid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentWorkPlanBiddingPreferenceResponse"}},"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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentWorkPlanBid:submit"]},"x-purecloud-method-name":"patchWorkforcemanagementWorkplanbidPreferences"}},"/api/v2/workforcemanagement/workplanbids/{bidId}/workplans":{"get":{"tags":["Workforce Management"],"summary":"Gets an agent's work plans for a bid","description":"","operationId":"getWorkforcemanagementWorkplanbidWorkplans","produces":["application/json"],"parameters":[{"name":"bidId","in":"path","description":"The ID of the work plan bid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AgentWorkPlanListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentWorkPlanBid:submit"]},"x-purecloud-method-name":"getWorkforcemanagementWorkplanbidWorkplans"}},"/api/v2/workforcemanagement/alternativeshifts/settings":{"get":{"tags":["Workforce Management"],"summary":"Get alternative shifts settings from the current logged in agent’s business unit","description":"","operationId":"getWorkforcemanagementAlternativeshiftsSettings","produces":["application/json"],"parameters":[],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AlternativeShiftBuSettingsResponse"}},"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","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:agentAlternativeShift:submit"]},"x-purecloud-method-name":"getWorkforcemanagementAlternativeshiftsSettings"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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"}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/workplanbids/{bidId}/groups/summary":{"get":{"tags":["Workforce Management"],"summary":"Get summary of bid groups that belong to a work plan bid","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidGroupSummaryList"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups":{"post":{"tags":["Workforce Management"],"summary":"Add a bid group in a given work plan bid","description":"","operationId":"postWorkforcemanagementBusinessunitWorkplanbidGroups","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanBidGroupCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidGroupResponse"}},"201":{"description":"The work plan bid group was successfully created","schema":{"$ref":"#/definitions/WorkPlanBidGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWorkplanbidGroups"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}":{"get":{"tags":["Workforce Management"],"summary":"Get a bid group by bid group Id","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbidGroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"Work Plan Bid Group id","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbidGroup"},"delete":{"tags":["Workforce Management"],"summary":"Delete a bid group by bid group Id","description":"","operationId":"deleteWorkforcemanagementBusinessunitWorkplanbidGroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"Work Plan Bid Group id","required":true,"type":"string"}],"responses":{"204":{"description":"The bid 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","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWorkplanbidGroup"},"patch":{"tags":["Workforce Management"],"summary":"Update a bid group by bid group Id","description":"","operationId":"patchWorkforcemanagementBusinessunitWorkplanbidGroup","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"Work Plan Bid Group id","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanBidGroupUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidGroupResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitWorkplanbidGroup"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences":{"get":{"tags":["Workforce Management"],"summary":"Gets the work plan preferences of all the agents in the work plan bid group","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"The ID of the work plan bid group","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdminAgentWorkPlanPreferenceResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBidGroup:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences"},"patch":{"tags":["Workforce Management"],"summary":"Overrides the assigned work plan for the specified agents","description":"","operationId":"patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The work plan bid id of the bid groups","required":true,"type":"string"},{"name":"bidGroupId","in":"path","description":"The ID of the work plan bid group","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/AgentsBidAssignedWorkPlanOverrideRequest"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/AdminAgentWorkPlanPreferenceResponse"}},"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":"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:workPlanBidGroup:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences"}},"/api/v2/workforcemanagement/users/workplanbidranks/bulk":{"patch":{"tags":["Workforce Management"],"summary":"Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.","description":"","operationId":"patchWorkforcemanagementUsersWorkplanbidranksBulk","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Users","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/WorkPlanBidRanks"}}}],"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","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 of the requested resources in the request body 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementUsersWorkplanbidranksBulk"}},"/api/v2/workforcemanagement/users/{userId}/workplanbidranks":{"get":{"tags":["Workforce Management"],"summary":"Get work plan bid ranks for a user","description":"","operationId":"getWorkforcemanagementUserWorkplanbidranks","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The userId to whom the work plan bid ranks apply.","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidRanks"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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:workPlanBid:view"]},"x-purecloud-method-name":"getWorkforcemanagementUserWorkplanbidranks"},"patch":{"tags":["Workforce Management"],"summary":"Update work plan bid ranks for a user","description":"","operationId":"patchWorkforcemanagementUserWorkplanbidranks","produces":["application/json"],"parameters":[{"name":"userId","in":"path","description":"The userId to whom the work plan bid ranks apply.","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/WorkPlanBidRanks"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBidRanks"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at 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 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"division.authorization.timeout":"Division authorization timed out.","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:workPlanBid:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementUserWorkplanbidranks"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}":{"get":{"tags":["Workforce Management"],"summary":"Get a work plan bid","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbid","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The id of the workplanbid","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBid"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbid"},"delete":{"tags":["Workforce Management"],"summary":"Delete a work plan bid","description":"","operationId":"deleteWorkforcemanagementBusinessunitWorkplanbid","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The ID of the work plan bid","required":true,"type":"string"}],"responses":{"204":{"description":"The work plan bid 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.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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:delete"]},"x-purecloud-method-name":"deleteWorkforcemanagementBusinessunitWorkplanbid"},"patch":{"tags":["Workforce Management"],"summary":"Update work plan bid","description":"","operationId":"patchWorkforcemanagementBusinessunitWorkplanbid","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The id of the workplanbid","required":true,"type":"string"},{"in":"body","name":"body","description":"The work plan bid to be updated","required":true,"schema":{"$ref":"#/definitions/UpdateWorkPlanBid"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBid"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:edit"]},"x-purecloud-method-name":"patchWorkforcemanagementBusinessunitWorkplanbid"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids":{"get":{"tags":["Workforce Management"],"summary":"Get list of work plan bids","description":"","operationId":"getWorkforcemanagementBusinessunitWorkplanbids","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/WorkPlanBidListResponse"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:view"]},"x-purecloud-method-name":"getWorkforcemanagementBusinessunitWorkplanbids"},"post":{"tags":["Workforce Management"],"summary":"Create a new work plan bid","description":"","operationId":"postWorkforcemanagementBusinessunitWorkplanbids","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"in":"body","name":"body","description":"The work plan bid to be created","required":false,"schema":{"$ref":"#/definitions/CreateWorkPlanBid"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBid"}},"201":{"description":"The work plan bid was successfully created","schema":{"$ref":"#/definitions/WorkPlanBid"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWorkplanbids"}},"/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy":{"post":{"tags":["Workforce Management"],"summary":"Copy a work plan bid","description":"","operationId":"postWorkforcemanagementBusinessunitWorkplanbidCopy","produces":["application/json"],"parameters":[{"name":"businessUnitId","in":"path","description":"The ID of the business unit","required":true,"type":"string"},{"name":"bidId","in":"path","description":"The ID of the work plan bid to copy","required":true,"type":"string"},{"in":"body","name":"body","description":"body","required":false,"schema":{"$ref":"#/definitions/CopyWorkPlanBid"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkPlanBid"}},"201":{"description":"The work plan bid was successfully created","schema":{"$ref":"#/definitions/WorkPlanBid"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed out.","schema":{"$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:workPlanBid:add"]},"x-purecloud-method-name":"postWorkforcemanagementBusinessunitWorkplanbidCopy"}},"/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.query.operator.and.type":"Certain operators and types cannot be used together","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.query.null.with.operator.and.type":"Null values cannot be used with certain operators and types","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"pre.check.entity.used":"Workbin still being used by a Worktype.","request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"Workbin","required":true,"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","queue.ids.not.found":"Queue ID does not exist","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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]","query.filters.validation":"Query filters validation error","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","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","request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.","queue.ids.not.found":"Queue ID does not exist","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.cannot.remove.only.wrapup":"A users last wrap-up code cannot be removed.","request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"wrapup.cannot.remove.only.wrapup":"A users last wrap-up code cannot be removed.","request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","pre.check.worktype.has.flow":"Cannot delete a status when its worktype is linked to a workitem flow.","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.","pre.check.status.referenced.by.rule":"The status is being referenced by a rule."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Status","required":true,"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.auto.transition.disabled.for.terminate.status":"A status that terminates cannot add an auto transition.","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.default.status.cannot.be.terminating":"The initial status of a workitem cannot be configured as terminating status.","invalid.input.destinations.without.default.destination":"Destinations list does not contain the default destination.","invalid.input.auto.terminate.not.applicable.for.status.category":"Auto termination is not applicable for this status category.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"Status","required":true,"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.auto.transition.disabled.for.terminate.status":"A status that terminates cannot add an auto transition.","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.auto.terminate.not.applicable.for.status.category":"Auto termination is not applicable for this status category.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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.query.operator.and.type":"Certain operators and types cannot be used together","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.query.null.with.operator.and.type":"Null values cannot be used with certain operators and types","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","flow","defaultScript"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"Worktype","required":true,"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.default.status.cannot.be.terminating":"The initial status of a workitem cannot be configured as terminating status.","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.","queue.ids.not.found":"Queue ID does not exist","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.","pre.check.cannot.launch.flow.and.start.assignment":"A Worktype cannot be configured to launch both a flow and start assignment at workitem creation 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":["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":"Worktype","required":true,"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.","queue.ids.not.found":"Queue ID does not exist","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId}":{"get":{"tags":["Task Management"],"summary":"Get an attribute change rule","description":"","operationId":"getTaskmanagementWorktypeFlowsOnattributechangeRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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 rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeFlowsOnattributechangeRule"},"delete":{"tags":["Task Management"],"summary":"Delete a rule","description":"","operationId":"deleteTaskmanagementWorktypeFlowsOnattributechangeRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","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","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 rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorktypeFlowsOnattributechangeRule"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a rule","description":"","operationId":"patchTaskmanagementWorktypeFlowsOnattributechangeRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"},{"in":"body","name":"body","description":"Rule","required":true,"schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRuleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"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","client.failed.request":"The client 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.no.change":"No changes found in request.","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 Rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","pre.check.name.in.use":"Name is already in use.","pre.check.conflicting.rule.condition":"Condition conflicts with another rules condition.","pre.check.cannot.have.equal.old.and.new.values":"Condition cannot having equal old and new values."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorktypeFlowsOnattributechangeRule"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules":{"get":{"tags":["Task Management"],"summary":"Get all attribute-change rules for a worktype","description":"","operationId":"getTaskmanagementWorktypeFlowsOnattributechangeRules","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"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRuleListing"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeFlowsOnattributechangeRules"},"post":{"tags":["Task Management"],"summary":"Add an attribute-change rule to a worktype","description":"","operationId":"postTaskmanagementWorktypeFlowsOnattributechangeRules","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"in":"body","name":"body","description":"Rule","required":true,"schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRuleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"201":{"description":"Workitem rule created.","schema":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"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.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","pre.check.name.in.use":"Name is already in use.","pre.check.maximum.limit.reached":"The maximum amount of allowed attribute-change rules has been reached.","pre.check.conflicting.rule.condition":"Condition conflicts with another rules condition.","pre.check.cannot.have.equal.old.and.new.values":"Condition cannot having equal old and new values."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnAttributeChange:add"]},"x-purecloud-method-name":"postTaskmanagementWorktypeFlowsOnattributechangeRules"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId}":{"get":{"tags":["Task Management"],"summary":"Get an on-create rule","description":"","operationId":"getTaskmanagementWorktypeFlowsOncreateRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"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 rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnCreate:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeFlowsOncreateRule"},"delete":{"tags":["Task Management"],"summary":"Delete a rule","description":"","operationId":"deleteTaskmanagementWorktypeFlowsOncreateRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","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","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 rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnCreate:delete"]},"x-purecloud-method-name":"deleteTaskmanagementWorktypeFlowsOncreateRule"},"patch":{"tags":["Task Management"],"summary":"Update the attributes of a rule","description":"","operationId":"patchTaskmanagementWorktypeFlowsOncreateRule","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"name":"ruleId","in":"path","description":"ruleId","required":true,"type":"string"},{"in":"body","name":"body","description":"Rule","required":true,"schema":{"$ref":"#/definitions/WorkitemOnCreateRuleUpdate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"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","client.failed.request":"The client 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.no.change":"No changes found in request.","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 Rule not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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:flowRuleOnCreate:edit"]},"x-purecloud-method-name":"patchTaskmanagementWorktypeFlowsOncreateRule"}},"/api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules":{"get":{"tags":["Task Management"],"summary":"Get all on-create rules for a worktype","description":"","operationId":"getTaskmanagementWorktypeFlowsOncreateRules","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"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnCreateRuleListing"}},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnCreate:view"]},"x-purecloud-method-name":"getTaskmanagementWorktypeFlowsOncreateRules"},"post":{"tags":["Task Management"],"summary":"Add an on-create rule to a worktype","description":"","operationId":"postTaskmanagementWorktypeFlowsOncreateRules","produces":["application/json"],"parameters":[{"name":"worktypeId","in":"path","description":"Worktype id","required":true,"type":"string"},{"in":"body","name":"body","description":"Rule","required":true,"schema":{"$ref":"#/definitions/WorkitemOnCreateRuleCreate"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"201":{"description":"Workitem rule created.","schema":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","pre.check.name.in.use":"Name is already in use.","pre.check.maximum.limit.reached":"The maximum amount of allowed on-create rules has been reached for the worktype.","pre.check.cannot.launch.flow.and.start.assignment":"Worktype cannot have both assignmentEnabled set to true and an on-create launch flow rule."}},"413":{"description":"The request is over the size limit. Maximum bytes: %s","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.entity.too.large":"The request is over the size limit. Maximum bytes: %s"}},"415":{"description":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"unsupported.media.type":"Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header."}},"429":{"description":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"too.many.requests.retry.after":"Rate limit exceeded the maximum. Retry the request in [%s] seconds","too.many.requests":"Rate limit exceeded the maximum [%s] requests within [%s] seconds"}},"500":{"description":"The server encountered an unexpected condition which prevented it from fulfilling the request.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"internal.server.error":"The server encountered an unexpected condition which prevented it from fulfilling the request."}},"503":{"description":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"service.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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:flowRuleOnCreate:add"]},"x-purecloud-method-name":"postTaskmanagementWorktypeFlowsOncreateRules"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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.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 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/{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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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","no.permission.for.requested.users":"The requested users are in a division you do not have permission to.","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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. Informational, AssessedContent and Assessment are deprecated","required":true,"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment","External","Native"]}],"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","Coaching","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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/employeeengagement/celebrations/{celebrationId}":{"delete":{"tags":["Employee Engagement"],"summary":"Deletes a celebration","description":"","operationId":"deleteEmployeeengagementCelebration","produces":["application/json"],"parameters":[{"name":"celebrationId","in":"path","description":"The ID of the celebration","required":true,"type":"string"}],"responses":{"204":{"description":"Celebration 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:celebration:delete"]},"x-purecloud-method-name":"deleteEmployeeengagementCelebration"},"patch":{"tags":["Employee Engagement"],"summary":"Set a state for a celebration","description":"","operationId":"patchEmployeeengagementCelebration","produces":["application/json"],"parameters":[{"name":"celebrationId","in":"path","description":"The ID of the celebration","required":true,"type":"string"},{"in":"body","name":"body","description":"Patch Celebration state","required":true,"schema":{"$ref":"#/definitions/CelebrationStateParam"}}],"responses":{"204":{"description":"Celebration State 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:celebration:edit"]},"x-purecloud-method-name":"patchEmployeeengagementCelebration"}},"/api/v2/employeeengagement/celebrations":{"get":{"tags":["Employee Engagement"],"summary":"Get all celebrations","description":"","operationId":"getEmployeeengagementCelebrations","produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","required":false,"type":"integer","default":25,"format":"int32"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/GetCelebrationListing"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement","employee-engagement:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:celebration:view"]},"x-purecloud-method-name":"getEmployeeengagementCelebrations"}},"/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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."}},"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/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":{"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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"Assignment created","schema":{"$ref":"#/definitions/LearningAssignment"}},"202":{"description":"Assignment creation request accepted","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/{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":"Assignment rescheduled","schema":{"$ref":"#/definitions/LearningAssignment"}},"202":{"description":"Assignment reschedule request accepted","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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/{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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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"}},"202":{"description":"Assignment reassign request accepted","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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/{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":"defaultShareableContentObject","in":"query","description":"The default SCO to retrieve","required":false,"type":"string","enum":["First","Last","Next"]},{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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}/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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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. Informational, AssessedContent and Assessment are deprecated","required":false,"type":"array","items":{"type":"string","enum":["Informational","AssessedContent","Assessment","External","Native"]},"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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}/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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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":{"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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts with the current state of the target resource.","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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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/employeeengagement/recognitions/{recognitionId}":{"get":{"tags":["Employee Engagement"],"summary":"Gets a single recognition","description":"","operationId":"getEmployeeengagementRecognition","produces":["application/json"],"parameters":[{"name":"recognitionId","in":"path","description":"The Recognition ID","required":true,"type":"string"}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/Recognition"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","receiver.caller.mismatch":"Permission denied, caller does not match the recipient","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement","employee-engagement:readonly"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:recognition:view"]},"x-purecloud-method-name":"getEmployeeengagementRecognition"}},"/api/v2/employeeengagement/recognitions":{"post":{"tags":["Employee Engagement"],"summary":"Creates a recognition","description":"","operationId":"postEmployeeengagementRecognitions","produces":["application/json"],"parameters":[{"in":"body","name":"body","description":"Create Recognition","required":true,"schema":{"$ref":"#/definitions/CreateRecognition"}}],"responses":{"200":{"description":"successful operation","schema":{"$ref":"#/definitions/RecognitionBase"}},"400":{"description":"The request could not be understood by the server due to malformed syntax.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"bad.request":"The request could not be understood by the server due to malformed syntax.","response.entity.too.large":"The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable","invalid.date":"Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ","invalid.query.param.value":"Value [%s] is not valid for parameter [%s]. Allowable values are: %s","client.failed.request":"The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.","invalid.property":"Value [%s] is not a valid property for object [%s]","constraint.validation":"%s","invalid.value":"Value [%s] is not valid for field type [%s]. Allowable values are: %s"}},"401":{"description":"No authentication bearer token specified in authorization header.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"authentication.required":"No authentication bearer token specified in authorization header.","ip.not.authorized":"Requests originating from this IP address are not authorized: [%s]","bad.credentials":"Invalid login credentials."}},"403":{"description":"You are not authorized to perform the requested action.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"missing.division.permission":"Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).","app.not.authorized.for.scope":"App not authorized to use scope %s","missing.permissions":"Unable to perform the requested action. You are missing the following permission(s): %s","not.authorized":"You are not authorized to perform the requested action.","missing.any.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s","authz.policy.denied":"Unable to perform the requested action. Your organization's security policies have denied access. Policy ID(s): [%s]","missing.any.division.permissions":"Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s"}},"404":{"description":"The requested resource was not found.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"not.found":"The requested resource was not found."}},"408":{"description":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"client.timeout":"The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads."}},"409":{"description":"The request conflicts with the current state of the target resource.","schema":{"$ref":"#/definitions/ErrorBody"},"x-inin-error-codes":{"request.conflict":"The request conflicts 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.unavailable":"Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance)."}},"504":{"description":"The request timed 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-engagement"]}],"x-inin-requires-permissions":{"type":"ANY","permissions":["engagement:recognition:add"]},"x-purecloud-method-name":"postEmployeeengagementRecognitions"}}},"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."}}},"EmailCommunicationSentMessageEvent":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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."}}},"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}}},"Empty":{"type":"object"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"DomainEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"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}}},"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"}}},"OAuthAuthorizationListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/OAuthAuthorization"}},"selfUri":{"type":"string","format":"uri"}}},"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}}},"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"},"inactivityTimeoutExclusions":{"type":"array","description":"The list of exempt apis from inactivity timeout.","items":{"type":"string"}}}},"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"}}},"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"}}},"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"}}},"AutoAnswerSetting":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"The media type status."}}},"AutoAnswerSettings":{"type":"object","required":["settings"],"properties":{"settings":{"type":"object","description":"Map of conversation media type enabled status.","additionalProperties":{"$ref":"#/definitions/AutoAnswerSetting"}}}},"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"}}},"ExternalContactsSettings":{"type":"object","properties":{"manuallyAssignDivisionsToInteractions":{"type":"boolean"},"manuallyAssignDivisionsToContacts":{"type":"boolean"}}},"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/Image"}},"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"},"includeOwners":{"type":"boolean","description":"Allow owners to be included as members of the group"},"callsEnabled":{"type":"boolean","description":"Allow calls to be placed 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"]}}},"Image":{"type":"object","properties":{"resolution":{"type":"string","description":"Height and/or width of image. ex: 640x480 or x128"},"imageUri":{"type":"string"}}},"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/Image"}},"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"},"workPlanBidRanks":{"description":"The WFM work plan bid rank settings for the user","readOnly":true,"$ref":"#/definitions/WorkPlanBidRanks"},"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"}}},"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 user."},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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","hasAnswerHighlight","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"}}},"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"}}},"AgentCopilotAggregateDataContainer":{"type":"object","properties":{"group":{"type":"object","description":"A mapping from dimension to value","additionalProperties":{"type":"string"}},"data":{"type":"array","items":{"$ref":"#/definitions/StatisticalResponse"}}}},"AgentCopilotAggregateQueryResponse":{"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/definitions/AgentCopilotAggregateDataContainer"}}}},"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","hasAnswerHighlight","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."}}},"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","botFlowSubType","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","previewMode","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","botFlowSubType","botFlowType","botId","botIntent","botProduct","botProvider","botRecognitionFailureReason","botResult","botSessionId","botSlot","botVersion","conversationId","externalContactId","intermediateIntentName","knowledgeBaseId","languageCode","lastActionId","lastInputActionId","mediaType","messageType","previewMode","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"}}},"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","originatingSocialMediaPublic","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","originatingSocialMediaPublic","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","oMessageCount","oMessageSegmentCount","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","oMessageCount","oMessageSegmentCount","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","internalmessage","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"]},"screenRecording":{"type":"boolean","description":"Flag determining if a screen recording was started or not"},"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","internalmessage","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","originatingSocialMediaPublic"],"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","oMessageCount","oMessageSegmentCount","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","screenRecording","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"]},"screenRecording":{"type":"boolean","description":"Flag determining if a screen recording was started or not"},"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","mediaType","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","mediaType","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","flowSubType","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","flowSubType","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","internalmessage","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"}}},"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","nWorkitemsOffered","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAgentFocusComplete","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","nWorkitemsOffered","nWorkitemsOverSla","nWorkitemsPurged","nWorkitemsQueueTransferred","nWorkitemsStatusChanged","nWorkitemsTerminated","nWorkitemsTimedout","nWorkitemsTransferred","nWorkitemsWrapupAdded","nWorkitemsWrapupRemoved","oWorkitemsServiceLevel","tWorkitemsAgentFocusComplete","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"}}},"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"}}},"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"}}},"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"}}},"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"}}},"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"}}}},"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"}}}},"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"]}}},"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"},"dateCompleted":{"type":"string","format":"date-time","description":"Timestamp indicating when the original turn was completed. Note: The 'interval' query param uses this timestamp to filter the output. 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","PartialCollection","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","SetWrapupCodeAction","TransferPureMatchAction","GetAttributesAction","SetAttributesAction","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"},"dateCompleted":{"type":"string","format":"date-time","description":"Timestamp indicating when the session was completed. Note: The 'interval' query param uses this timestamp to filter the output. 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","Open","Instagram","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"}}},"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}}},"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","dateDeleted","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"},"dateDeleted":{"type":"string","format":"date-time","description":"The deleted 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"}}}},"SocialKeyword":{"type":"object","properties":{"includes":{"type":"array","description":"List of keywords that must be included","items":{"type":"string"}},"excludes":{"type":"array","description":"List of keywords that must be excluded","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","internalmessage","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","apple"]}},"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","Native"]}},"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"}},"dashboardType":{"type":"string","description":"The type of dashboard being filtered","enum":["All","Public","Private","Shared","Favorites","Deleted"]},"dashboardAccessFilter":{"type":"string","description":"The type of dashboard access being filtered","enum":["OwnedByMe","OwnedByAnyone","NotOwnedByMe"]},"transcriptDurationMilliseconds":{"type":"array","description":"The transcript durations in milliseconds used to filter the view","items":{"$ref":"#/definitions/NumericRange"}},"workitemsStatuses":{"type":"array","description":"The list of workitem status with worktype","items":{"$ref":"#/definitions/WorkitemStatusFilter"}},"socialCountries":{"type":"array","description":"List of countries for social filtering","items":{"type":"string"}},"socialLanguages":{"type":"array","description":"List of languages for social filtering","items":{"type":"string"}},"socialChannels":{"type":"array","description":"List of channels for social filtering","items":{"type":"string","enum":["Twitter","Facebook","Instagram","Open"]}},"socialSentimentCategory":{"type":"array","description":"The sentiment of the social post","items":{"type":"string","enum":["Positive","Negative","Neutral","Unknown"]}},"socialTopicIds":{"type":"array","description":"The list of topicIds for social filtering","items":{"type":"string"}},"socialIngestionRuleIds":{"type":"array","description":"The list of ingestion ruleIds for social filtering","items":{"type":"string"}},"socialConversationCreated":{"type":"boolean","description":"Filter to indicate if the post has created a conversation"},"socialContentType":{"type":"array","description":"The list of content Type for social filtering","items":{"type":"string","enum":["Text","Image","Video"]}},"socialKeywords":{"type":"array","description":"The list of keywords for social filtering","items":{"$ref":"#/definitions/SocialKeyword"}},"socialPostEscalated":{"type":"boolean","description":"Filter to indicate if the post is escalated"},"socialClassifications":{"type":"array","description":"Indicates if a social message was public or private","items":{"type":"string","enum":["Public","Private"]}},"filterUsersByManagerIds":{"type":"array","description":"The manager ids used to fetch associated users for the view","items":{"type":"string"}},"slideshowIds":{"type":"array","description":"List of Dashboard slideshowIds to be filtered","items":{"type":"string"}},"conferenced":{"type":"boolean","description":"Filter to indicate if the conversation has conference"}}},"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","internalmessage","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"]}},"agentInteractionSortOrder":{"type":"string","description":"The sort order of the interactions in the agent status widget.","enum":["ascending","descending"]}}},"WorkitemStatusFilter":{"type":"object","properties":{"worktypeId":{"type":"string","description":"Worktype ID belonging to the selected workitem status"},"workitemStatusId":{"type":"string","description":"Workitem status ID"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","SOCIAL_LISTENING_VIEW","SOCIAL_LISTENING_POSTS_VIEW","AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW","DASHBOARD_SLIDESHOWS","DASHBOARD_SLIDESHOWS_DETAIL","AGENT_COPILOT_PERFORMANCE_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","BAD_REQUEST_SCHEDULED_RUN"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","SOCIAL_LISTENING_VIEW","SOCIAL_LISTENING_POSTS_VIEW","AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW","DASHBOARD_SLIDESHOWS","DASHBOARD_SLIDESHOWS_DETAIL","AGENT_COPILOT_PERFORMANCE_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","SOCIAL_LISTENING_VIEW","SOCIAL_LISTENING_POSTS_VIEW","AGENT_PERFORMANCE_TIMELINE_DETAIL_VIEW","DASHBOARD_SLIDESHOWS","DASHBOARD_SLIDESHOWS_DETAIL","AGENT_COPILOT_PERFORMANCE_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"}}},"AnswerGenerationConfig":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Answer generation is enabled."}}},"Copilot":{"type":"object","required":["defaultLanguage","liveOnQueue"],"properties":{"enabled":{"type":"boolean","description":"Copilot is enabled.","readOnly":true},"liveOnQueue":{"type":"boolean","description":"Copilot is live on selected queue."},"defaultLanguage":{"type":"string","description":"Copilot default language, e.g. [en-US, es-US, es-ES]. Once set, it can not be modified."},"knowledgeAnswerConfig":{"description":"Knowledge answer configuration.","$ref":"#/definitions/KnowledgeAnswerConfig"},"summaryGenerationConfig":{"description":"Copilot generated summary configuration.","$ref":"#/definitions/SummaryGenerationConfig"},"wrapupCodePredictionConfig":{"description":"Copilot generated wrapup code prediction configuration.","$ref":"#/definitions/WrapupCodePredictionConfig"},"answerGenerationConfig":{"description":"Answer generation configuration.","$ref":"#/definitions/AnswerGenerationConfig"},"nluEngineType":{"type":"string","description":"Language understanding engine type.","enum":["NluV3"]},"nluConfig":{"description":"NLU configuration.","$ref":"#/definitions/NluConfig"},"ruleEngineConfig":{"description":"Rule engine configuration.","$ref":"#/definitions/RuleEngineConfig"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CopilotAction":{"type":"object","required":["actionType"],"properties":{"actionType":{"type":"string","description":"Type of action.","enum":["KnowledgeArticle","CannedResponse","Script"]},"attributes":{"type":"object","description":"Action specific attributes, if any. Maximum 100 of string key-value pair allowed.","additionalProperties":{"type":"string"}}}},"CopilotCondition":{"type":"object","required":["conditionType","conditionValues"],"properties":{"conditionType":{"type":"string","description":"Type of condition.","enum":["Intent","ConversationStart","ConversationTransfer","ConversationEnd"]},"conditionValues":{"type":"array","description":"Condition values.","items":{"type":"string"}}}},"CopilotFallbackAction":{"type":"object","required":["actionType"],"properties":{"actionType":{"type":"string","description":"Type of action.","enum":["KnowledgeArticle","CannedResponse","Script","KnowledgeSearch"]},"attributes":{"type":"object","description":"Action specific attributes, if any. Maximum 100 of string key-value pair allowed.","additionalProperties":{"type":"string"}}}},"CopilotNluDomain":{"type":"object","required":["id","useLatestVersion"],"properties":{"id":{"type":"string","description":"Id of the NLU domain."},"useLatestVersion":{"type":"boolean","description":"Use the latest version of the NLU domain. If false, version is required."},"version":{"description":"NLU domain version.","$ref":"#/definitions/CopilotNluDomainVersion"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CopilotNluDomainVersion":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the NLU v3 domain version."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CopilotRule":{"type":"object","required":["actions","conditions"],"properties":{"conditions":{"type":"array","description":"List of conditions to execute actions, must have at least 1 element and maximum 100 elements. Operator in case of multiple conditions: 'OR'.","items":{"$ref":"#/definitions/CopilotCondition"}},"actions":{"type":"array","description":"List of actions to execute, must have at least 1 element and maximum 100 elements.","items":{"$ref":"#/definitions/CopilotAction"}}}},"CopilotTranscriptionConfig":{"type":"object","required":["engine"],"properties":{"engine":{"type":"string","description":"The Transcription engine for Agent Copilot.","enum":["Genesys","GenesysExtended"]}}},"Fallback":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Fallback actions are enabled."},"actions":{"type":"array","description":"Fallback actions.","items":{"$ref":"#/definitions/CopilotFallbackAction"}}}},"KnowledgeAnswerConfig":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Knowledge answer is enabled."}}},"NluConfig":{"type":"object","required":["domain","intentConfidenceThreshold"],"properties":{"domain":{"description":"NLU domain.","$ref":"#/definitions/CopilotNluDomain"},"intentConfidenceThreshold":{"type":"number","format":"float","description":"Minimum confidence value of accepting NLU intents, must be greater than 0 and less than 1."}}},"RuleConfig":{"type":"object","required":["enabled","rule"],"properties":{"id":{"type":"string","description":"Rule ID."},"enabled":{"type":"boolean","description":"Rule enabled."},"rule":{"description":"Rule configuration.","$ref":"#/definitions/CopilotRule"}}},"RuleEngineConfig":{"type":"object","required":["rules"],"properties":{"rules":{"type":"array","description":"List of rules to evaluate by the engine.","items":{"$ref":"#/definitions/RuleConfig"}},"fallback":{"description":"Fallback configuration.","$ref":"#/definitions/Fallback"}}},"SummaryGenerationConfig":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Copilot generated summary is enabled."}}},"WrapupCodePredictionConfig":{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Copilot generated wrapup code prediction is enabled."}}},"ArticlesFilter":{"type":"object","properties":{"labels":{"description":"The labels filter.","$ref":"#/definitions/LabelsFilter"},"categories":{"description":"The categories filter.","$ref":"#/definitions/CategoriesFilter"}}},"Assistant":{"type":"object","required":["knowledgeSuggestionConfig","name","transcriptionConfig"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the assistant that will assist the agent."},"dateCreated":{"type":"string","format":"date-time","description":"Date when the assistant 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 when the assistant 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 assistant.","readOnly":true,"$ref":"#/definitions/UserReference"},"modifiedBy":{"description":"The user who last modified the assistant.","readOnly":true,"$ref":"#/definitions/UserReference"},"googleDialogflowConfig":{"description":"(Deprecated: use the 'knowledgeSuggestionConfig' for genesys knowledge suggestions) Configuration of Dialogflow used to assist the agent with transcriptions and knowledge suggestions.","$ref":"#/definitions/GoogleDialogflowConfig"},"transcriptionConfig":{"description":"Configuration for speech transcription used to assist the agent.","$ref":"#/definitions/TranscriptionConfig"},"knowledgeSuggestionConfig":{"description":"Configuration that defines how to produce knowledge suggestions.","$ref":"#/definitions/KnowledgeSuggestionConfig"},"state":{"type":"string","description":"State of the assistant.","readOnly":true,"enum":["Active","Inactive"]},"copilot":{"description":"Agent copilot configuration.","readOnly":true,"$ref":"#/definitions/Copilot"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AssistantQueue":{"type":"object","required":["id","mediaTypes"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the queue."},"mediaTypes":{"type":"array","description":"List of media Types in which the assistant is activated for this queue.","items":{"type":"string","enum":["Call","Email","Message"]}},"assistant":{"description":"Assistant to which the queue is assigned.","readOnly":true,"$ref":"#/definitions/Assistant"},"dateCreated":{"type":"string","format":"date-time","description":"Date when the assistant queue 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 when the assistant queue was last 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}}},"CategoriesFilter":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"A list of categories to filter by. Articles matching any of the specified categories can be accessed.","items":{"$ref":"#/definitions/CategoryEntity"}}}},"CategoryEntity":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Id of the category."},"selfUri":{"type":"string","format":"uri","description":"The selfUri of the category.","readOnly":true}}},"ConversationProfile":{"type":"object","required":["languageCode","name"],"properties":{"languageCode":{"type":"string","description":"The language code supported by the conversation profile belonging to a particular project for Dialogflow.","enum":["en","en-AU","en-CA","en-GB","en-IN","en-US"]},"name":{"type":"string","description":"The name of the conversation profile belonging to a particular project for Dialogflow"}}},"GoogleDialogflowConfig":{"type":"object","required":["conversationProfiles"],"properties":{"integrationId":{"type":"string","description":"The integration identifier with which the assistant will fetch transcriptions and knowledge suggestions."},"conversationProfiles":{"type":"array","description":"The conversation profiles for which the assistant will fetch transcription and knowledge suggestions.","items":{"$ref":"#/definitions/ConversationProfile"}}}},"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}}},"KnowledgeBaseWithDialectReference":{"type":"object","required":["id","languageCode"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the knowledge base."},"languageCode":{"type":"string","description":"The dialect for the knowledge base.","enum":["en-ZA","en-AU","en-GB","en-IE","en-IN","en-US","es-US","es-ES","nl-NL","fr-CA","fr-FR","de-DE","it-IT","pt-PT","pt-BR","ar-AE","ja-JP","sv-SE","de-AT","de-CH","da-DK","fr-BE","fr-CH","es-MX","es-CO","es-AR"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSuggestionConfig":{"type":"object","required":["vendorName"],"properties":{"vendorName":{"type":"string","description":"The name of vendor used for knowledge suggestions.","enum":["GoogleDialogflow","GenesysKnowledge","Unknown"]},"knowledgeBase":{"description":"The ID of knowledge base to query when Genesys is the knowledge suggestions provider.","$ref":"#/definitions/KnowledgeBaseReference"},"knowledgeBases":{"type":"array","description":"The knowledge bases to query based on dialect, when Genesys is the knowledge suggestions provider.","items":{"$ref":"#/definitions/KnowledgeBaseWithDialectReference"}}}},"LabelEntity":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Id of the label."},"selfUri":{"type":"string","format":"uri","description":"The selfUri of the label.","readOnly":true}}},"LabelsFilter":{"type":"object","required":["entities"],"properties":{"entities":{"type":"array","description":"A list of labels to filter by. Articles matching any of the specified labels can be accessed.","items":{"$ref":"#/definitions/LabelEntity"}}}},"TranscriptionConfig":{"type":"object","required":["vendorName"],"properties":{"vendorName":{"type":"string","description":"The name of the vendor used for speech transcription.","enum":["GoogleDialogflow","Unknown","Genesys"]}}},"AssistantQueueListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AssistantQueue"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"AssistantListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Assistant"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"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"}}}},"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"}}}},"AuditQueryExecutionLargeResultsResponse":{"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."},"downloadUrl":{"type":"string","description":"The presigned url which can be used to download the results."}}},"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"}}}},"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"}}}},"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"}}},"UserReferenceEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UserReference"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"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"}}},"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}}},"RoleSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"backfillEnabled":{"type":"boolean","description":"Boolean showing if organization is opted in or not to role backfills"},"authorizationGrantDivisionAware":{"type":"boolean","description":"Boolean enabling enforcement of division aware for authorization grant add and delete","allowEmptyValue":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: 60 min). Can only be used when ACW is AGENT_REQUESTED, 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"}},"mode":{"type":"string","description":"The mode callbacks will use on this queue.","enum":["AgentFirst","CustomerFirst"]},"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."},"pacingModifier":{"type":"number","format":"double","description":"Controls the maximum number of outbound calls at one time when mode is CustomerFirst."},"liveVoiceReactionType":{"type":"string","description":"The action to take if a live voice is detected during the outbound call of a customer first callback.","enum":["HangUp","TransferToQueue","TransferToFlow"]},"liveVoiceFlow":{"description":"The inbound flow to transfer to if a live voice is detected during the outbound call of a customer first callback.","$ref":"#/definitions/DomainEntityRef"},"answeringMachineReactionType":{"type":"string","description":"The action to take if an answering machine is detected during the outbound call of a customer first callback.","enum":["HangUp","TransferToQueue","TransferToFlow"]},"answeringMachineFlow":{"description":"The inbound flow to transfer to if an answering machine is detected during the outbound call of a customer first callback when answeringMachineReactionType is set to TransferToFlow.","$ref":"#/definitions/DomainEntityRef"}}},"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"}}},"EmailMediaSettings":{"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"}}}},"ExpansionCriterium":{"type":"object","properties":{"type":{"type":"string","enum":["TIMEOUT_SECONDS"]},"threshold":{"type":"number","format":"double"}}},"IdentityResolutionConfig":{"type":"object","required":["resolveIdentities"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"resolveIdentities":{"type":"boolean","description":"Whether the channel should resolve identities"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"IdentityResolutionQueueConfig":{"type":"object","properties":{"callOnBehalfOfQueue":{"$ref":"#/definitions/IdentityResolutionConfig"}}},"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"},"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."},"cannedResponseLibraries":{"description":"Canned response library IDs and mode with which they are associated with the queue","$ref":"#/definitions/CannedResponseLibraries"},"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":{"description":"The default email address to use for outbound email from this queue.","$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/EmailMediaSettings"},"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"}}},"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"EntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"type":"object"}}}},"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","business.rules","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gamification","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","internal.messaging","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"}}},"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, expressed as int in the range [10,3650]"}}},"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 if adhoc, the id of the group for group rooms","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"}},"jid":{"type":"string","description":"The jid of the room"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"AiScoringSetting":{"type":"object","properties":{"enabled":{"type":"boolean","description":"True if AI Scoring feature is configured."}}},"AiScoringSettings":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"questionGroupSettings":{"type":"array","items":{"$ref":"#/definitions/QuestionGroupSettings"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"evaluationSettings":{"description":"Settings for evaluations associated with this form","$ref":"#/definitions/EvaluationSettings"},"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":{"revisionsEnabled":{"type":"boolean","description":"Whether revisions are allowed for evaluations. When enabled, rescoring creates a new version of the evaluation and retracts the existing evaluation version. Does not apply for calibration evaluations."},"disputesEnabled":{"type":"boolean","description":"Whether disputes are allowed for evaluations. Does not apply for calibration evaluations."},"disputesAllowedPerEvaluation":{"type":"integer","format":"int32","description":"The maximum number of disputes allowed for an evaluation."},"disputesAssignees":{"type":"array","description":"A list of assignees responsible for handling each dispute. This list size needs to be equal to disputesAllowedPerEvaluation.","items":{"$ref":"#/definitions/EvaluationSettingsAssignee"}}}},"EvaluationSettingsAssignee":{"type":"object","properties":{"user":{"description":"The user the dispute should be assigned to","$ref":"#/definitions/UserReferenceWithName"},"type":{"type":"string","description":"The assignee type. Valid values: Original, Individual, None","enum":["Original","Individual","None"]}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"QuestionGroupSettings":{"type":"object","properties":{"questionGroupContextId":{"type":"string","description":"The context id of the question group in the form."},"questionSettings":{"type":"array","items":{"$ref":"#/definitions/QuestionSettings"}}}},"QuestionSettings":{"type":"object","properties":{"questionContextId":{"type":"string","description":"The context id of the question in the group"},"settings":{"$ref":"#/definitions/AiScoringSetting"}}},"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"},"description":{"type":"string","description":"The wrap-up code description."},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","SocialInstagram","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":"Indicates the built-in entity type to which this schema applies.","readOnly":true,"items":{"type":"string","enum":["CONTACT","CONVERSATION","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"},"externalIds":{"type":"array","description":"A list of external identifiers that identify this contact in an external system","uniqueItems":true,"items":{"$ref":"#/definitions/ExternalId"}},"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"},"handle":{"type":"string","description":"The handle 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/Image"}},"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"},"workPlanBidRanks":{"description":"The WFM work plan bid rank settings for the user","readOnly":true,"$ref":"#/definitions/WorkPlanBidRanks"},"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"},"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"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ContactIdentifierListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactIdentifier"}}}},"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"},"lastUri":{"type":"string","format":"uri"},"previousUri":{"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","INTERNAL_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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"CursorExternalSourceListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExternalSource"}},"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","InternalMessage"]},"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."},"divisionIds":{"type":"array","description":"List of division IDs associated with the session.","items":{"type":"string"}},"lastScreen":{"type":"string","description":"The app screen name where the customer's last app interaction occurred."},"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"}}}},"ContactImportJobStatusUpdateResponse":{"type":"object","properties":{"jobId":{"type":"string"},"status":{"type":"string","enum":["Continue","Cancel","Retry"]}}},"ContactImportJobStatusUpdateRequest":{"type":"object","required":["jobId","status"],"properties":{"jobId":{"type":"string","description":"Job Id"},"status":{"type":"string","description":"Workflow status","enum":["Continue","Cancel","Retry"]}}},"ContactImportJobMetadata":{"type":"object","properties":{"fileName":{"type":"string"},"dryRunFailedCount":{"type":"integer","format":"int32"},"dryRunSuccessCount":{"type":"integer","format":"int32"},"dryRunReportDownloadUrl":{"type":"string"},"importFailedCount":{"type":"integer","format":"int32"},"importSuccessCount":{"type":"integer","format":"int32"},"importReportDownloadUrl":{"type":"string"}}},"ContactImportJobResponse":{"type":"object","required":["settings"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","enum":["Created","Running","Completed","Failed","Cancelled"]},"statusDetails":{"type":"string","description":"Detailed description for JobStatus."},"executionStep":{"type":"string","description":"Detailed description for the Job execution state","enum":["Validating","Validated","Importing"]},"metadata":{"description":"Metadata for the job","$ref":"#/definitions/ContactImportJobMetadata"},"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},"settings":{"description":"Settings","$ref":"#/definitions/AddressableEntityRef"}}},"ContactImportJobRequest":{"type":"object","required":["settingsId"],"properties":{"settingsId":{"type":"string","description":"Settings id"}}},"ContactImportJobEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactImportJobResponse"}},"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"}}},"ContactImportField":{"type":"object","required":["included","name"],"properties":{"name":{"type":"string","description":"Field name"},"included":{"type":"boolean","description":"Should we import this field"}}},"ContactImportSettings":{"type":"object","required":["externalSourceId","importFields","mergeContacts","name"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Display name for the settings"},"matchingCriteria":{"type":"array","description":"Which fields you want to identity resolution based on. (e.g.: Email, Phone). It can be empty, populated only one of them or it can be both for now. The order of the items is important for identity resolution","items":{"type":"string","enum":["Email","Phone"]}},"mergeContacts":{"type":"boolean","description":"Decides what happens when a record already found in the system. Action will be Upsert or Merge"},"externalSourceId":{"type":"string","description":"Define the corresponding source system by the customer, the customer can have different externalId source, they can collect this id from contact service"},"importFields":{"type":"array","description":"Decides which field we need to send towards contact service","items":{"$ref":"#/definitions/ContactImportField"},"maxItems":2147483647,"minItems":1},"dateCreated":{"type":"string","format":"date-time","description":"Creation date for the settings. 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}}},"ContactImportSettingsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ContactImportSettings"}},"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"}}},"CsvJobResponse":{"type":"object","required":["job"],"properties":{"job":{"description":"Job for the import","$ref":"#/definitions/AddressableEntityRef"}}},"CsvJobRequest":{"type":"object","required":["settingsId","uploadId"],"properties":{"uploadId":{"type":"string","description":"Upload for the csv job"},"settingsId":{"type":"string","description":"Settings for the csv job"}}},"CsvMappingEntry":{"type":"object","required":["sourceField","targetField"],"properties":{"sourceField":{"type":"string","description":"CSV field to map data from"},"targetField":{"type":"string","description":"Json path to map data to"}}},"CsvSettings":{"type":"object","required":["mappings"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"externalSettingsId":{"type":"string","description":"Id of the external settings"},"mappings":{"type":"array","description":"Mappings for the transformation","items":{"$ref":"#/definitions/CsvMappingEntry"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"Listing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/CsvSettings"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"CsvUploadDetailsResponse":{"type":"object","required":["uploadId","validationResult"],"properties":{"uploadId":{"type":"string","description":"Id for the upload"},"fileName":{"type":"string","description":"File name for the upload"},"validationResult":{"description":"Validation for the upload","$ref":"#/definitions/ValidationResult"}}},"ValidationError":{"type":"object","required":["lineNumber","message"],"properties":{"lineNumber":{"type":"integer","format":"int64","description":"Line number for the error in CSV"},"message":{"type":"string","description":"Detail of the error in CSV"}}},"ValidationResult":{"type":"object","required":["errors","fileEncodingValid","separatorValid"],"properties":{"separatorValid":{"type":"boolean","description":"Separator valid in the upload"},"fileEncodingValid":{"type":"boolean","description":"File encoding valid for the upload"},"errors":{"type":"array","description":"List of errors for the upload","items":{"$ref":"#/definitions/ValidationError"}}}},"CsvUploadPreviewResponse":{"type":"object","required":["entries","headers","uploadId"],"properties":{"uploadId":{"type":"string","description":"Id for the upload"},"headers":{"type":"array","description":"List of headers in the CSV","items":{"type":"string"}},"entries":{"type":"array","description":"List of entries in the CSV","items":{"type":"array","items":{"type":"string"}}}}},"CsvUploadResponse":{"type":"object","required":["uploadHeaders","uploadId","uploadUrl"],"properties":{"uploadId":{"type":"string","description":"Id of the upload"},"uploadUrl":{"type":"string","description":"Url for the upload"},"uploadHeaders":{"type":"array","description":"Required headers for the upload","items":{"$ref":"#/definitions/Header"}}}},"Header":{"type":"object","properties":{"name":{"type":"string","description":"Name of the header"},"value":{"type":"string","description":"Value of the header"}}},"CsvUploadRequest":{"type":"object","required":["fileSize"],"properties":{"fileName":{"type":"string","description":"Name of the file to upload","minLength":0,"maxLength":256},"fileSize":{"type":"integer","format":"int64","description":"The size of the upload file","maximum":52428800}}},"DocumentThumbnail":{"type":"object","properties":{"resolution":{"type":"string"},"imageUri":{"type":"string"},"height":{"type":"integer","format":"int32"},"width":{"type":"integer","format":"int32"}}},"DownloadResponse":{"type":"object","properties":{"id":{"type":"string"},"contentLocationUri":{"type":"string"},"imageUri":{"type":"string"},"thumbnails":{"type":"array","items":{"$ref":"#/definitions/DocumentThumbnail"}},"state":{"type":"string","enum":["Running","Completed"]},"resultUri":{"type":"string"},"selfUri":{"type":"string"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","LowHistoricalAccuracyError"]}}},"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/DivisionEntityRef"}}}},"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":["Reactions","Attachment","Location","QuickReply","Notification","ButtonResponse","Story","Mention","Card","Carousel","Text","QuickReplyV2","DatePicker","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"}}},"DivisionEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"dateDivisionUpdated":{"type":"string","format":"date-time","description":"The time the entity division was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"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"},"parkTime":{"type":"string","format":"date-time","description":"Represents the time when an email was put into parked state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"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","INTERNAL_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."}}},"InternalMessage":{"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."},"segments":{"type":"array","description":"The time line of the participant's internal message, divided into activity segments.","items":{"$ref":"#/definitions/Segment"}},"disconnectType":{"type":"string","description":"System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects.","enum":["client","system","peer","transfer"]},"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."},"peerId":{"type":"string","description":"The id of the peer communication corresponding to a matching leg for this communication."},"targetUserId":{"type":"string","description":"The user ID for the participant on receiving side of the internal message conversation."},"sourceUserId":{"type":"string","description":"The user ID for the participant on sending side of the internal message conversation."},"toAddress":{"description":"Address for the participant on receiving side of the internal message communication.","$ref":"#/definitions/Address"},"fromAddress":{"description":"Address for the participant on the sending side of the internal message communication.","$ref":"#/definitions/Address"},"messages":{"type":"array","description":"The messages sent on this communication channel.","items":{"$ref":"#/definitions/InternalMessageDetails"}}}},"InternalMessageDetails":{"type":"object","properties":{"messageId":{"type":"string","description":"UUID identifying the internal message media."},"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"}}},"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"},"socialVisibility":{"type":"string","description":"For social media messages, the visibility of the message in the originating social platform","enum":["private","public"]},"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."},"externalContactInitialDivisionId":{"type":"string","description":"If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned."},"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"},"internalMessages":{"type":"array","items":{"$ref":"#/definitions/InternalMessage"}},"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"}}},"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"}}},"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."}}},"ConversationUtilizationLabelUpdate":{"type":"object","properties":{"utilizationLabelId":{"type":"string","description":"The utilization label 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"]},"keepInternalMessageAlive":{"type":"boolean","description":"If true, the digital internal message will NOT be terminated."},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"agentOwnedColumn":{"type":"string","description":"Name of the contact list column containing the id of the agent who owns the record. Only applicable to preview campaigns."},"dynamicContactQueueingSettings":{"description":"Settings for dynamic queueing of contacts.","$ref":"#/definitions/DynamicContactQueueingSettings"},"skillColumns":{"type":"array","description":"The skill columns on the ContactList that this Campaign should take into account when dialing","items":{"type":"string"}},"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"},"filter":{"type":"boolean","description":"Whether to filter 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"ParkingStateRequest":{"type":"object","required":["state"],"properties":{"state":{"type":"string","description":"State to set the participant.","enum":["alerting","dialing","contacting","offering","connected","disconnected","terminated","converting","uploading","transmitting","parked","none"]}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","DatePicker"]},"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."},"ConversationContentDatePicker":{"type":"object","properties":{"title":{"type":"string","description":"Text to show in the title."},"subtitle":{"type":"string","description":"Text to show in the description."},"imageUrl":{"type":"string","description":"URL of an image"},"dateMinimum":{"type":"string","format":"date-time","description":"The minimum Date Enabled in the datepicker calendar, format: ISO 8601."},"dateMaximum":{"type":"string","format":"date-time","description":"The maximum Date Enabled in the datepicker calendar, format: ISO 8601."},"availableTimes":{"type":"array","description":"An array of available times objects.","items":{"$ref":"#/definitions/ConversationContentDatePickerAvailableTime"}}},"description":"DateTimePicker content object."},"ConversationContentDatePickerAvailableTime":{"type":"object","properties":{"duration":{"type":"integer","format":"int64","description":"The duration of the scheduling event in seconds."},"dateTime":{"type":"string","format":"date-time","description":"The date and time of the event being scheduled. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}},"description":"A datetimepicker available time that a user can take."},"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."},"ConversationContentReaction":{"type":"object","required":["count"],"properties":{"reactionType":{"type":"string","description":"Type of reaction.","enum":["None","Like","Love","Wow","Haha","Sad","Angry","Thankful","Pride","Care","Share","Comment","View"]},"count":{"type":"integer","format":"int32","description":"Number of users that reacted this way to the message."}},"description":"User reaction to public message."},"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."},"ConversationEnrichment":{"type":"object","properties":{"language":{"description":"Detected language of this message.","$ref":"#/definitions/ConversationEnrichmentLanguage"},"sentimentV2":{"description":"Detected sentiment of this message.","$ref":"#/definitions/ConversationEnrichmentSentimentV2"}},"description":"Metadata enrichments provided by the platform."},"ConversationEnrichmentLanguage":{"type":"object","required":["language"],"properties":{"language":{"type":"string","description":"The IETF detected language code of this message."}},"description":"Detected language of this message."},"ConversationEnrichmentSentimentV2":{"type":"object","required":["tag"],"properties":{"tag":{"type":"string","description":"Detected Sentiment tag","enum":["Unknown","Positive","Negative","Neutral"]}},"description":"Sentiment analysis of this message."},"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."}},"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":["Reactions","Attachment","Location","QuickReply","Notification","ButtonResponse","Story","Mention","Card","Carousel","Text","QuickReplyV2","DatePicker","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","Apple","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},"externalContactId":{"type":"string","description":"The identifier of the external contact."},"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","Topic"]},"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},"externalContactId":{"type":"string","description":"The identifier of the external contact."},"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."},"ConversationNotificationTemplateButton":{"type":"object","required":["index","type"],"properties":{"type":{"type":"string","description":"Specifies the type of the button.","enum":["QuickReply","PhoneNumber","Url"]},"text":{"type":"string","description":"Button text message."},"index":{"type":"integer","format":"int64","description":"index of the button in the list."},"phoneNumber":{"type":"string","description":"Button phone number."},"url":{"type":"string","description":"Button URL link."},"parameters":{"type":"array","description":"Template parameters for placeholders in the button.","items":{"$ref":"#/definitions/ConversationNotificationTemplateParameter"}}},"description":"Template button 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."},"ConversationPublicMetadata":{"type":"object","properties":{"rootId":{"type":"string","description":"The id of the root public message."},"replyToId":{"type":"string","description":"The id of the message this public message is replying to."}},"description":"Information about a public message."},"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","Topic","IngestionRule","IngestionRuleVersion"]},"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","whatsapp","webmessaging","instagram","open","apple"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"parkTime":{"type":"string","format":"date-time","description":"The time when this participant's communication was last parked. Does not reset on resume. 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"}}},"TextMessageListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MessageData"}}}},"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/SendMessagingTemplateRequest"}}},"SendMessagingTemplateRequest":{"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. (Deprecated) use bodyParameters instead.","items":{"$ref":"#/definitions/TemplateParameter"}},"headerParameters":{"type":"array","description":"A list of Response Management header parameter substitutions for the response's messaging template","items":{"$ref":"#/definitions/TemplateParameter"}},"bodyParameters":{"type":"array","description":"A list of Response Management body parameter substitutions for the response's messaging template","items":{"$ref":"#/definitions/TemplateParameter"}},"buttonUrlParameters":{"type":"array","description":"A list of Response Management button url parameter 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"}}},"CreateOutboundMessagingConversationResponse":{"type":"object","properties":{"id":{"type":"string","description":"The created outbound messaging conversation ID.","readOnly":true},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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, unless useUserFromAddress is true and the queue is configured to use the agent's Direct Routing address as the fromAddress."},"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."},"useUserFromAddress":{"type":"boolean","description":"An override to attempt to use the user's configured direct routing address as the fromAddress. \nIf set to true, users configured address with 'directrouting' integration will be used as fromAddress. \nIf set to false or not set, the queueId will be used for determining fromAddress."}}},"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. (Deprecated - Instead use message.normalizedMessage.text)"},"messagingTemplate":{"description":"The messaging template sent. (Deprecated - Instead use message.normalizedMessage.content[#].template)","$ref":"#/definitions/SendMessagingTemplateRequest"},"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/SendMessagingTemplateRequest"},"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"}}},"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"},"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"}},"conversationId":{"type":"string","description":"The conversationId context for the message"}},"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","DatePicker","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","Failed"]},"messengerType":{"type":"string","description":"The type of Messaging Integration","readOnly":true,"enum":["sms","facebook","twitter","whatsapp","webmessaging","instagram","open","apple"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","whatsapp","webmessaging","instagram","open","apple"]},"timeoutInMinutes":{"type":"integer","format":"int64","description":"The conversation threading window timeout (Minutes) of specified messenger type"}}},"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"},"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"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","InstagramPublic","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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"OpenMessagingIdentityResolutionConfig":{"type":"object","required":["resolveIdentities"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"resolveIdentities":{"type":"boolean","description":"Whether the channel should resolve identities"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","Failed"]},"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"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."}}},"Digits":{"type":"object","properties":{"digits":{"type":"string","description":"A string representing the digits pressed on phone."}}},"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"]},"keepInternalMessageAlive":{"type":"boolean","description":"If true, the digital internal message will NOT be terminated."},"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"]},"keepInternalMessageAlive":{"type":"boolean","description":"If true, the digital internal message will NOT be terminated."},"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"]},"keepInternalMessageAlive":{"type":"boolean","description":"If true, the digital internal message will NOT be terminated."},"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"}}}},"Feedback":{"type":"object","required":["relevance","suggestionId"],"properties":{"suggestionId":{"type":"string","description":"Feedback suggestion id."},"userProvided":{"type":"boolean","description":"Indicates whether the answer/item was clicked by the human agent or not."},"relevance":{"type":"string","description":"Feedback relevance.","enum":["Unknown","Relevant","Irrelevant"]}}},"Article":{"type":"object","properties":{"title":{"type":"string","description":"The article title.","readOnly":true},"uri":{"type":"string","description":"The URI for the article.","readOnly":true},"snippets":{"type":"array","description":"This contains snippets of text from the article matching the query.","readOnly":true,"items":{"type":"string"}},"confidence":{"type":"number","format":"float","description":"Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all.","readOnly":true},"metadata":{"type":"object","description":"A map that contains custom metadata about the article answer.","readOnly":true,"additionalProperties":{"$ref":"#/definitions/MetadataAttribute"}},"version":{"description":"The version of the Article.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"variations":{"type":"array","description":"Variations of the Article.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"Faq":{"type":"object","properties":{"question":{"type":"string","description":"Question from the knowledge base that was matched to user request.","readOnly":true},"answer":{"type":"string","description":"Answer from the knowledge base corresponding to the identified question.","readOnly":true},"sourceUri":{"type":"string","description":"A URI uniquely identifying the document, e.g. projects/acme-inc/knowledgeBases/MTAyNjgxNDU1Nzc3NTM1NzU0MjQ/documents/MTI5ODc3NzQzOTQ5MTc5NzgxMTI.","readOnly":true},"documentUrl":{"type":"string","description":"URL pointing to a web page if document was sourced from a URL.","readOnly":true},"documentDisplayName":{"type":"string","description":"A human-readable description of the document, e.g. 'Sample store FAQ'","readOnly":true},"confidence":{"type":"number","format":"float","description":"Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all","readOnly":true}}},"MetadataAttribute":{"type":"object","properties":{"value":{"type":"string","description":"The value of the metadata attribute.","readOnly":true}}},"Suggestion":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of the documents for which the suggestion is.","readOnly":true,"enum":["Faq","Article","KnowledgeArticle","KnowledgeSearch","CannedResponse","Script"]},"faq":{"description":"The Faq from the knowledgebase that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/Faq"},"article":{"description":"The article from the knowledgebase that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/Article"},"dateCreated":{"type":"string","format":"date-time","example":"2020-09-25T11:57:02Z","description":"Date when the suggestion was created. For example: yyyy-MM-ddTHH:mm:ss.SSZ. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"answerRecordId":{"type":"string","description":"The ID of the knowledge search that provided the suggestion.","readOnly":true},"triggerType":{"type":"string","description":"The trigger type of the suggestion.","readOnly":true,"enum":["Unknown","Fallback","ConversationStart","ConversationTransfer","ConversationEnd","Intent"]},"context":{"description":"The conversation context in which the suggestion was raised.","readOnly":true,"$ref":"#/definitions/SuggestionContext"},"state":{"type":"string","description":"The state of the suggestion.","readOnly":true,"enum":["Suggested","Accepted","Dismissed","Failed","Rated"]},"knowledgeSearch":{"description":"The suggested knowledge search result that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/SuggestionKnowledgeSearch"},"knowledgeArticle":{"description":"The suggested knowledge article that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/SuggestionKnowledgeArticle"},"cannedResponse":{"description":"The suggested canned response that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/SuggestionCannedResponse"},"script":{"description":"The suggested script that was provided as the suggestion.","readOnly":true,"$ref":"#/definitions/SuggestionScript"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"conversation":{"description":"The conversation that the suggestions correspond to.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"assistant":{"description":"The assistant that was used to provide the suggestions.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SuggestionCannedResponse":{"type":"object","properties":{"response":{"description":"The suggested response.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"library":{"description":"The library from which the canned response is suggested","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"}}},"SuggestionContext":{"type":"object","properties":{"queue":{"description":"The queue used to assign the interaction to the user, if any.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"mediaType":{"type":"string","description":"The media type of the conversation in which the suggestion event was raised.","readOnly":true,"enum":["Message","Voice","Unknown"]},"user":{"description":"The agent participant who received the raised suggestion, if any.","readOnly":true,"$ref":"#/definitions/UserReference"},"externalContact":{"description":"The external contact of the end-user participant, if any.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"utterance":{"description":"The utterance in the voice conversation, after which the suggestion was raised, if any.","readOnly":true,"$ref":"#/definitions/Entity"},"message":{"description":"The message in the digital conversation, after which the suggestion was raised, if any.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"queryStatement":{"type":"string","description":"The query statement used when generating the suggestion, if any.","readOnly":true}}},"SuggestionKnowledgeAnswer":{"type":"object","properties":{"answer":{"type":"string","description":"The most relevant answer","readOnly":true},"startIndex":{"type":"integer","format":"int32","description":"The start index of the answer","readOnly":true},"endIndex":{"type":"integer","format":"int32","description":"The end index of the answer","readOnly":true}}},"SuggestionKnowledgeArticle":{"type":"object","properties":{"title":{"type":"string","description":"The article title.","readOnly":true},"snippets":{"type":"array","description":"Snippets of text from the article matching the query.","readOnly":true,"items":{"type":"string"}},"document":{"description":"The article.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"version":{"description":"The version of the article.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"knowledgeAnswer":{"description":"The most relevant answer within the suggested article.","readOnly":true,"$ref":"#/definitions/SuggestionKnowledgeAnswer"},"variations":{"type":"array","description":"The variations of the article.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"SuggestionKnowledgeSearch":{"type":"object","properties":{"title":{"type":"string","description":"The article title.","readOnly":true},"snippets":{"type":"array","description":"Snippets of text from the article matching the query.","readOnly":true,"items":{"type":"string"}},"confidence":{"type":"number","format":"float","description":"Value between 0 and 1. 1 corresponds to very confident, 0 to not confident at all.","readOnly":true},"searchId":{"type":"string","description":"The search id.","readOnly":true},"document":{"description":"The article matching the query.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"version":{"description":"The version of the article.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"knowledgeAnswer":{"description":"The most relevant answer within a searched article for the searched query","readOnly":true,"$ref":"#/definitions/SuggestionKnowledgeAnswer"},"variations":{"type":"array","description":"Variations of the article.","readOnly":true,"items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"SuggestionListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Suggestion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"SuggestionScript":{"type":"object","properties":{"script":{"description":"The suggested script.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"page":{"description":"The page of the script.","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"data":{"type":"object","description":"The payload for the script.","readOnly":true,"additionalProperties":{"type":"string"}}}},"SuggestionEngagement":{"type":"object","required":["engagementType"],"properties":{"engagementType":{"type":"string","description":"The type of engagement with the suggestion.","enum":["Dismissed","Copied","Opened","Feedback"]},"feedback":{"description":"The given feedback on the suggestion, if any.","$ref":"#/definitions/SuggestionFeedback"}}},"SuggestionFeedback":{"type":"object","required":["rating"],"properties":{"rating":{"type":"string","description":"The rating value of the suggestion feedback.","enum":["Negative","Positive"]}}},"ConversationEditedSummary":{"type":"object","properties":{"text":{"type":"string","description":"The text of the edited summary."},"dateModified":{"type":"string","format":"date-time","description":"The modification date of the edited summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"ConversationSessionSummary":{"type":"object","properties":{"text":{"type":"string","description":"The text of the summary."},"status":{"type":"string","description":"The status of the conversation summary.","enum":["Pending","Queued","Started","Completed","Error","Processing"]},"mediaType":{"type":"string","description":"The media type of the conversation.","enum":["Email","Call","Chat","Message","Webmessaging","Unknown"]},"language":{"type":"string","description":"The language of the conversation."},"predictedWrapupCodes":{"type":"array","description":"The wrapup codes of the conversation summary.","items":{"$ref":"#/definitions/ConversationSummaryWrapupCode"}},"editedSummary":{"description":"The edited summary of the conversation.","$ref":"#/definitions/ConversationEditedSummary"},"reason":{"description":"The reason of the conversation summary.","$ref":"#/definitions/ConversationSummaryReason"},"followup":{"description":"The followup of the conversation summary.","$ref":"#/definitions/ConversationSummaryFollowup"},"resolution":{"description":"The resolution of the conversation summary.","$ref":"#/definitions/ConversationSummaryResolution"},"dateCreated":{"type":"string","format":"date-time","description":"The created date of the summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"id":{"type":"string","description":"The id of the summary.","readOnly":true},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true},"participants":{"type":"array","description":"The list of participants.","items":{"$ref":"#/definitions/AddressableEntityRef"}},"communication":{"description":"The communication object of the summary.","readOnly":true,"$ref":"#/definitions/Entity"}}},"ConversationSummariesGetResponse":{"type":"object","properties":{"conversation":{"description":"The conversation object.","$ref":"#/definitions/AddressableEntityRef"},"summary":{"description":"The summary of the conversation.","$ref":"#/definitions/ConversationSummary"},"sessionSummaries":{"type":"array","description":"All the summaries of the session.","items":{"$ref":"#/definitions/ConversationSessionSummary"}}},"description":"Defines the summaries of a conversation."},"ConversationSummary":{"type":"object","properties":{"text":{"type":"string","description":"The text of the summary."},"status":{"type":"string","description":"The status of the conversation summary.","enum":["Pending","Queued","Started","Completed","Error","Processing"]},"mediaType":{"type":"string","description":"The media type of the conversation.","enum":["Email","Call","Chat","Message","Webmessaging","Unknown"]},"language":{"type":"string","description":"The language of the conversation."},"predictedWrapupCodes":{"type":"array","description":"The wrapup codes of the conversation summary.","items":{"$ref":"#/definitions/ConversationSummaryWrapupCode"}},"editedSummary":{"description":"The edited summary of the conversation.","$ref":"#/definitions/ConversationEditedSummary"},"reason":{"description":"The reason of the conversation summary.","$ref":"#/definitions/ConversationSummaryReason"},"followup":{"description":"The followup of the conversation summary.","$ref":"#/definitions/ConversationSummaryFollowup"},"resolution":{"description":"The resolution of the conversation summary.","$ref":"#/definitions/ConversationSummaryResolution"},"dateCreated":{"type":"string","format":"date-time","description":"The created date of the summary. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"id":{"type":"string","description":"The id of the summary.","readOnly":true},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true},"participants":{"type":"array","description":"The list of participants.","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"ConversationSummaryFollowup":{"type":"object","properties":{"text":{"type":"string","description":"The text of the followup."},"description":{"type":"string","description":"The description."},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true}}},"ConversationSummaryReason":{"type":"object","properties":{"text":{"type":"string","description":"The text of the reason."},"description":{"type":"string","description":"The description."},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true}}},"ConversationSummaryResolution":{"type":"object","properties":{"text":{"type":"string","description":"The text of the resolution."},"description":{"type":"string","description":"The description."},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true},"outcome":{"type":"string","description":"The outcome of the conversation's resolution.","readOnly":true}}},"ConversationSummaryWrapupCode":{"type":"object","properties":{"name":{"type":"string","description":"The name of the wrapup code."},"description":{"type":"string","description":"The description of the wrapup code."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"id":{"type":"string","description":"The id of the wrapup code.","readOnly":true},"confidence":{"type":"number","format":"float","description":"The AI confidence value.","readOnly":true}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"]}}},"MaskingRule":{"type":"object","required":["definition","enabled","name","substituteCharacter","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Masking rule name."},"description":{"type":"string","description":"Description about masking rule."},"substituteCharacter":{"type":"string","description":"Replacement character for masked text character."},"definition":{"type":"string","description":"Definition of masking rule (a valid regex or builtin AI based mask name)."},"enabled":{"type":"boolean","description":"True/False"},"type":{"type":"string","description":"Masking rule type","enum":["Custom","Predefined","Default"]},"integrations":{"type":"array","description":"Associated integration channels","items":{"type":"string"}},"dateCreated":{"type":"string","format":"date-time","example":"2024-07-08T07:11:42.619","description":"Date when the rule 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":"2024-07-08T07:13:51.647","description":"Date when the rule was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true}}},"MaskingRuleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/MaskingRule"}}}},"MaskingRuleValidateResponse":{"type":"object","properties":{"valid":{"type":"boolean","description":"is masking rule definition valid?","readOnly":true},"validationMessage":{"type":"string","description":"Validation message.","readOnly":true},"maskedText":{"type":"string","description":"Masked text.","readOnly":true}}},"MaskingRuleValidateRequest":{"type":"object","required":["definition","text"],"properties":{"text":{"type":"string","description":"Text to mask."},"definition":{"type":"string","description":"Regex to be applied"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"externalContactInitialDivisionId":{"type":"string","description":"If this participant represents an external contact, then this will be the initial division for the external contact. This value will not be updated if the external contact is reassigned."},"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"},"internalMessages":{"type":"array","items":{"$ref":"#/definitions/InternalMessage"}},"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"}}}},"CampaignPatchRequest":{"type":"object","properties":{"outboundLineCount":{"type":"integer","format":"int32","description":"The number of outbound lines to be concurrently dialed."},"abandonRate":{"type":"number","description":"The targeted compliance abandon rate percentage"},"maxCallsPerAgent":{"type":"number","description":"The maximum number of calls that can be placed per agent on this campaign"},"dynamicLineBalancingSettings":{"description":"Dynamic line balancing settings","$ref":"#/definitions/DynamicLineBalancingSettingsPatchRequest"},"queue":{"description":"The Queue for this Campaign to route calls to.","$ref":"#/definitions/AddressableEntityRef"}},"description":"Campaign patch request"},"DynamicLineBalancingSettingsPatchRequest":{"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"}}},"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},"filteredOutContactsCount":{"type":"integer","format":"int32","description":"Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on.","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"]}}}},"PagedSkillCombinationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/SkillCombinationInfo"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"SkillCombinationInfo":{"type":"object","properties":{"skillCombination":{"type":"array","description":"A skill combination in the contact queue","items":{"type":"string"}},"totalCount":{"type":"integer","format":"int64","description":"Number of total contacts in the contact queue for this skill combination","readOnly":true},"remainingCount":{"type":"integer","format":"int64","description":"Number of remaining contacts in the contact queue for this skill combination","readOnly":true}}},"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."},"campaignRuleProcessing":{"type":"string","description":"CampaignRule processing algorithm","enum":["v2"]},"conditionGroups":{"type":"array","description":"List of condition groups that are evaluated, used only with campaignRuleProcessing=\"v2\"","items":{"$ref":"#/definitions/CampaignRuleConditionGroup"}},"executionSettings":{"description":"CampaignRule execution settings","$ref":"#/definitions/CampaignRuleExecutionSettings"},"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","setCampaignMessagesPerMinute","changeCampaignQueue","changeCampaignTemplate"]},"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","campaignRecordsAttempted","campaignContactsMessaged","campaignBusinessSuccess","campaignBusinessFailure","campaignBusinessNeutral","campaignValidAttempts","campaignRightPartyContacts"]}}},"CampaignRuleConditionGroup":{"type":"object","required":["conditions","matchAnyConditions"],"properties":{"matchAnyConditions":{"type":"boolean","description":"Whether or not this condition group should be evaluated as true if any of sub conditions is matched"},"conditions":{"type":"array","description":"The parameters for the CampaignRuleCondition.","items":{"$ref":"#/definitions/CampaignRuleCondition"}}}},"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"}}}},"CampaignRuleExecutionSettings":{"type":"object","required":["frequency"],"properties":{"frequency":{"type":"string","description":"Execution control frequency","enum":["onEachTrigger","oncePerDay"]},"timeZoneId":{"type":"string","example":"Africa/Abidjan","description":"The time zone for the execution control frequency=\"oncePerDay\"; for example, Africa/Abidjan. This property is ignored when frequency is not \"oncePerDay\""}}},"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"]},"abandonRate":{"type":"number","description":"The abandon rate to set a campaign to. Required for the 'setCampaignAbandonRate' action."},"outboundLineCount":{"type":"integer","format":"int32","description":"The number of outbound lines to set a campaign to. Required for the 'setCampaignNumberOfLines' action."},"relativeWeight":{"type":"integer","format":"int32","description":"The relative weight to set a campaign to. Required for the 'setCampaignWeight' action."},"maxCallsPerAgent":{"type":"number","description":"The maximum number of calls per agent to set a campaign to. Required for the 'setCampaignMaxCallsPerAgent' action."},"queue":{"description":"The queue a campaign to. Required for the 'changeCampaignQueue' action.","$ref":"#/definitions/DomainEntityRef"},"messagesPerMinute":{"type":"integer","format":"int32","description":"The number of messages per minute to set a messaging campaign to."},"smsContentTemplate":{"description":"The content template to set a SMS campaign to.","$ref":"#/definitions/DomainEntityRef"},"emailContentTemplate":{"description":"The content template to set a Email campaign to.","$ref":"#/definitions/DomainEntityRef"}}},"CampaignRuleWarning":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Warning code for this warning.","enum":["ConditionsNoEntities","ConditionsNoSequences","ConditionsNoCampaigns","ConditionsNoMessagingCampaigns","ActionNoEntities","ActionNoSequences","ActionNoCampaigns","ActionNoMessagingCampaigns","NoQueue","NoContentTemplates","NoSmsContentTemplate","NoEmailContentTemplate"]},"message":{"type":"string","description":"Warning message for this warning."},"params":{"description":"Additional warning information","$ref":"#/definitions/CampaignRuleWarningParameters"}}},"CampaignRuleWarningParameters":{"type":"object","properties":{"actionId":{"type":"string","description":"ID of action"},"conditionId":{"type":"string","description":"ID of condition"},"actionType":{"type":"string","description":"Type of action","enum":["turnOnCampaign","turnOffCampaign","turnOnSequence","turnOffSequence","setCampaignPriority","recycleCampaign","setCampaignDialingMode","setCampaignAbandonRate","setCampaignNumberOfLines","setCampaignWeight","setCampaignMaxCallsPerAgent","setCampaignMessagesPerMinute","changeCampaignQueue","changeCampaignTemplate"]},"conditionType":{"type":"string","description":"Type of condition","enum":["campaignProgress","campaignAgents","campaignRecordsAttempted","campaignContactsMessaged","campaignBusinessSuccess","campaignBusinessFailure","campaignBusinessNeutral","campaignValidAttempts","campaignRightPartyContacts"]}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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/DivisionedDomainEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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}}},"DivisionedDomainEntityRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"}}},"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","example":"America/New_York","description":"The time zone for the recurrence. The time zone of the recurrence is determined by prioritizing the recurrence's time zone if specified, then the schedule's time zone if set, and finally defaulting to UTC if neither defines a time zone."},"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"}}},"CampaignBusinessCategoryMetrics":{"type":"object","properties":{"successCount":{"type":"integer","format":"int32","description":"Number of calls categorized as business success"},"neutralCount":{"type":"integer","format":"int32","description":"Number of calls categorized as business neutral"},"failureCount":{"type":"integer","format":"int32","description":"Number of calls categorized as business failure"}}},"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},"filteredOutContactsCount":{"type":"integer","format":"int32","description":"Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on.","readOnly":true},"rightPartyContactsCount":{"type":"integer","format":"int32","description":"Information on the campaign's number of Right Party Contacts","readOnly":true},"validAttempts":{"type":"integer","format":"int32","description":"Information on the campaign's valid attempts","readOnly":true},"linesUtilization":{"description":"Information on the campaign's lines utilization","readOnly":true,"$ref":"#/definitions/CampaignLinesUtilization"},"businessCategoryMetrics":{"description":"Information on the campaign's business category metrics","readOnly":true,"$ref":"#/definitions/CampaignBusinessCategoryMetrics"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"ContactsBulkOperationJobListing":{"type":"object","properties":{"total":{"type":"integer","format":"int64"},"entities":{"type":"array","items":{"$ref":"#/definitions/ContactsBulkOperationJob"}},"selfUri":{"type":"string","format":"uri"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","ANOTHER_CAMPAIGN_STARTING","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","QUEUE_NOT_FOUND","RECYCLE_CAMPAIGN","SCHEDULED_CAMPAIGN_INVALID","SCHEDULE_UNKNOWN_ERROR","SMS_CONTENT_TEMPLATE_NOT_FOUND","RECURRING_SCHEDULE_NEXT_OCCURRENCE_FAILURE","RECURRING_SCHEDULE_ENDED","RECURRING_SCHEDULE_MISSED_OCCURRENCES","VERSION_CONFLICT"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","BUSINESS_SUCCESS","BUSINESS_FAILURE","BUSINESS_NEUTRAL"]}},"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","BUSINESS_SUCCESS","BUSINESS_FAILURE","BUSINESS_NEUTRAL"]}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","forced_stopping"]},"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},"filteredOutContactsCount":{"type":"integer","format":"int32","description":"Number of contacts that don't match filter. This is currently supported only for Campaigns with dynamic filter on.","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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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/DivisionedDomainEntityRef"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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/DivisionedDomainEntityRef"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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/Image"}},"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"},"includeOwners":{"type":"boolean","description":"Allow owners to be included as members of the group"},"callsEnabled":{"type":"boolean","description":"Allow calls to be placed 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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/Image"}},"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"},"includeOwners":{"type":"boolean","description":"Allow owners to be included as members of the group"},"callsEnabled":{"type":"boolean","description":"Allow calls to be placed 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}}},"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","WorkitemId","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","WorkitemId","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."},"workitemId":{"type":"string","description":"The id of the workitem 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."},"flowWarningReason":{"type":"string","description":"If the flow had a warning, 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","internalmessage","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","internalmessage","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","internalmessage","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"}}},"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"}}},"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","internalmessage","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","description":"Social Handle Type","enum":["NAME","ADDRESS","PHONE","EMAIL","TWITTER"]},"existingValue":{"type":"string"},"updatedValue":{"type":"string"}}},"SocialHandle":{"type":"object","properties":{"type":{"type":"string","description":"Social Handle Type","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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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/Image"}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"TrustedCertificateInfo":{"type":"object","properties":{"description":{"type":"string","description":"The description of the certificate"},"serialNumber":{"type":"string","description":"The serial number of the certificate"},"signature":{"type":"string","description":"The signature of the certificate"}}},"TrustedCertificates":{"type":"object","properties":{"entities":{"type":"array","description":"The list of trusted certificates","items":{"$ref":"#/definitions/TrustedCertificateInfo"}},"total":{"type":"integer","format":"int32","description":"The total number of trusted certificates"}},"description":"Information about trusted certificates"},"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"}}},"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."},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"AudioConnectorIntegration":{"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}}},"AudioConnectorIntegrationEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AudioConnectorIntegration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"AsyncJob":{"type":"object","properties":{"id":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"state":{"type":"string","enum":["Running","Completed","Failed","Cancelled"]}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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":"(deprecated - use triggerWithOutcomeQuantileConditions instead) 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":"(deprecated - use triggerWithOutcomeQuantileConditions instead) 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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."}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}},"charts":{"type":"array","description":"A list of charts to measure within context of the elements of the the journey view","items":{"$ref":"#/definitions/JourneyViewChart"}},"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"},"displayAttributes":{"description":"Attributes that defines the visualization of the element in the journey view","$ref":"#/definitions/JourneyViewElementDisplayAttributes"},"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"},"JourneyViewElementDisplayAttributes":{"type":"object","required":["col","x","y"],"properties":{"x":{"type":"integer","format":"int32","description":"The horizontal position (x-coordinate) of the element on the journey view canvas"},"y":{"type":"integer","format":"int32","description":"The vertical position (y-coordinate) of the element on the journey view canvas"},"col":{"type":"integer","format":"int32","description":"The column position for the element in the journey view canvas"}},"description":"Display attributes for an element in a journey view"},"JourneyViewElementFilter":{"type":"object","required":["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"},"JourneyViewElementFilterNumberPredicate":{"type":"object","required":["dimension","range"],"properties":{"dimension":{"type":"string","description":"the element's attribute being filtered on"},"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"},"range":{"description":"the range of comparators to filter on","$ref":"#/definitions/JourneyViewElementFilterRange"}},"description":"A numeric filter 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"},"JourneyViewElementFilterRange":{"type":"object","properties":{"lt":{"description":"comparator: less than","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"lte":{"description":"comparator: less than or equal","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"gt":{"description":"comparator: greater than","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"gte":{"description":"comparator: greater than or equal","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"eq":{"description":"comparator: is equal to","$ref":"#/definitions/JourneyViewElementFilterRangeData"},"neq":{"description":"comparator: is not equal to","$ref":"#/definitions/JourneyViewElementFilterRangeData"}},"description":"the range of attribute values to filter on. At least one comparator must be defined"},"JourneyViewElementFilterRangeData":{"type":"object","properties":{"duration":{"type":"string","description":"An ISO 8601 time duration. Only one of number or duration must be specified."},"number":{"type":"number","format":"double","description":"A numeric value. Only one of number or duration must be specified."}}},"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":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyView"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","Cancelled"]},"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}}},"JourneyViewJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyViewJob"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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 "},"JourneyViewSchedule":{"type":"object","required":["dateModified","frequency","user"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"frequency":{"type":"string","description":"Frequency of execution","enum":["Daily","Weekly","Monthly"]},"dateModified":{"type":"string","format":"date-time","description":"Timestamp of last update. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"user":{"description":"Last modified user","readOnly":true,"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"JourneyViewScheduleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/JourneyViewSchedule"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."}}},"KnowledgeIntegrationDefaultSettings":{"type":"object","properties":{"baseUrl":{"type":"string","description":"The default base URL setting for the integration."}}},"KnowledgeIntegrationFilter":{"type":"object","properties":{"name":{"type":"string","description":"Filter name, which is the name of a setting in a knowledge source.","enum":["categories","channel","knowledgeBaseIds"]},"type":{"type":"string","description":"Filter type.","enum":["SingleSelect","MultiSelect"]},"action":{"type":"string","description":"Filter action.","enum":["None","FilterUpdate"]},"values":{"type":"array","description":"Available options of the filter setting.","items":{"$ref":"#/definitions/KnowledgeIntegrationFilterValue"}}}},"KnowledgeIntegrationFilterValue":{"type":"object","properties":{"key":{"type":"string","description":"The key that can be used as a value of a filter setting in a knowledge source."},"value":{"type":"string","description":"The display label of the filter value."}}},"KnowledgeIntegrationOptionsResponse":{"type":"object","properties":{"filters":{"type":"array","description":"Filter setting options available for a knowledge source.","items":{"$ref":"#/definitions/KnowledgeIntegrationFilter"}}}},"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, 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"]}}},"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}}},"KnowledgeIntegrationReference":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the integration."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SourceBaseResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the source."},"dateCreated":{"type":"string","format":"date-time","description":"Source 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":"Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The source type.","enum":["Salesforce","ServiceNow"]},"integration":{"description":"The reference to the integration associated with the source.","$ref":"#/definitions/KnowledgeIntegrationReference"},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours."},"lastSync":{"description":"Additional information about the last synchronization of the source.","$ref":"#/definitions/SourceLastSync"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SourceLastSync":{"type":"object","properties":{"state":{"type":"string","description":"State of the last synchronization.","enum":["Success","Failed","InProgress","Unknown"]},"dateStarted":{"type":"string","format":"date-time","description":"Last synchronization start-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateEnded":{"type":"string","format":"date-time","description":"Last synchronization end-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"error":{"description":"Optional error message of the last synchronization.","$ref":"#/definitions/ErrorBody"}}},"SalesforceSettings":{"type":"object","properties":{"channel":{"type":"string","description":"Filter source by channel.","enum":["App","Pkb","Csp","Prm"]},"language":{"type":"string","description":"Filter source by language."},"categories":{"type":"array","description":"Filter source by categories.","items":{"type":"string"}},"baseUrl":{"type":"string","description":"The base URL to resources."}}},"SalesforceSourceResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the source."},"dateCreated":{"type":"string","format":"date-time","description":"Source 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":"Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The source type.","enum":["Salesforce","ServiceNow"]},"integration":{"description":"The reference to the integration associated with the source.","$ref":"#/definitions/KnowledgeIntegrationReference"},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours."},"lastSync":{"description":"Additional information about the last synchronization of the source.","$ref":"#/definitions/SourceLastSync"},"settings":{"description":"The settings of the source.","$ref":"#/definitions/SalesforceSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SalesforceSourceRequest":{"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 integration source."},"integrationId":{"type":"string","description":"The integration associated with the source."},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours. Must be at least 6 and at most 48 hours.","minimum":6,"maximum":48},"settings":{"description":"The settings of the source.","$ref":"#/definitions/SalesforceSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"SourceSyncResponse":{"type":"object","properties":{"state":{"type":"string","description":"Sync state.","enum":["Success","Failed","InProgress","Unknown"]},"error":{"description":"Sync error.","$ref":"#/definitions/ErrorBody"},"dateCreated":{"type":"string","format":"date-time","description":"Synchronization creation date-time for this source. 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":"Synchronization last modification date-time for this source. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"knowledgeBase":{"description":"Knowledge base to which this synchronization belongs.","$ref":"#/definitions/AddressableEntityRef"},"source":{"description":"Source to which this synchronization belongs.","$ref":"#/definitions/AddressableEntityRef"}}},"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}}},"KnowledgeSyncJobReport":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors occurred during processing sync.","items":{"$ref":"#/definitions/ErrorBody"}},"statistics":{"description":"Statistics related to the sync job.","$ref":"#/definitions/KnowledgeSyncJobStatistics"}}},"KnowledgeSyncJobResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id of the sync job."},"uploadKey":{"type":"string"},"status":{"type":"string","description":"The status of the export job.","enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]},"report":{"description":"Report of the sync job","$ref":"#/definitions/KnowledgeSyncJobReport"},"knowledgeBase":{"description":"Knowledge base which document export belongs to.","$ref":"#/definitions/KnowledgeBaseReference"},"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"},"createdBy":{"description":"The user who created the operation","$ref":"#/definitions/UserReference"},"downloadURL":{"type":"string","description":"The URL of the location at which the caller can download the sync file, when available."},"failedEntitiesURL":{"type":"string","description":"The URL of the location at which the caller can download the entities in json format that failed during the sync."},"source":{"description":"Source of the sync job.","$ref":"#/definitions/KnowledgeOperationSource"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"KnowledgeSyncJobStatistics":{"type":"object","properties":{"countDocumentImportActivityCreate":{"type":"integer","format":"int32","description":"Number of documents will be created by the sync."},"countDocumentImportActivityUpdate":{"type":"integer","format":"int32","description":"Number of documents will be updated by the sync."},"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."},"countDocumentImportSuccess":{"type":"integer","format":"int32","description":"Number of imported documents."},"countDocumentImportFailure":{"type":"integer","format":"int32","description":"Number of documents failed to import."},"countCategoryImportSuccess":{"type":"integer","format":"int32","description":"Number of imported categories."},"countCategoryImportFailure":{"type":"integer","format":"int32","description":"Number of categories failed to import."},"countLabelImportSuccess":{"type":"integer","format":"int32","description":"Number of imported labels."},"countLabelImportFailure":{"type":"integer","format":"int32","description":"Number of labels failed to import."},"countDocumentDeleteSuccess":{"type":"integer","format":"int32","description":"Number of documents will be deleted by the sync."},"countDocumentDeleteFailure":{"type":"integer","format":"int32","description":"Number of documents failed to delete."},"countCategoryDeleteSuccess":{"type":"integer","format":"int32","description":"Number of successfully deleted categories."},"countCategoryDeleteFailure":{"type":"integer","format":"int32","description":"Number of categories failed to delete."},"countLabelDeleteSuccess":{"type":"integer","format":"int32","description":"Number of successfully deleted labels."},"countLabelDeleteFailure":{"type":"integer","format":"int32","description":"Number of labels failed to delete."}}},"ServiceNowSettings":{"type":"object","properties":{"knowledgeBaseIds":{"type":"array","description":"Filter source by knowledge base ids.","items":{"type":"string"}},"language":{"type":"string","description":"Filter source by language."},"categories":{"type":"array","description":"Filter source by categories.","items":{"type":"string"}},"baseUrl":{"type":"string","description":"The base URL to resources."}}},"ServiceNowSourceResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"Name of the source."},"dateCreated":{"type":"string","format":"date-time","description":"Source 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":"Source last modification date-time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The source type.","enum":["Salesforce","ServiceNow"]},"integration":{"description":"The reference to the integration associated with the source.","$ref":"#/definitions/KnowledgeIntegrationReference"},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours."},"lastSync":{"description":"Additional information about the last synchronization of the source.","$ref":"#/definitions/SourceLastSync"},"settings":{"description":"The settings of the source.","$ref":"#/definitions/ServiceNowSettings"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ServiceNowSourceRequest":{"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 integration source."},"integrationId":{"type":"string","description":"The integration associated with the source."},"schedulePeriod":{"type":"integer","format":"int32","description":"The schedule period of the source in hours. Must be at least 6 and at most 48 hours.","minimum":6,"maximum":48},"settings":{"description":"The settings of the source.","$ref":"#/definitions/ServiceNowSettings"},"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"}}},"AnswerGenerationDocument":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"title":{"type":"string","description":"The document title."},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraphWithHighlight"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListWithHighlight"},"table":{"description":"Table. It must contain a value if type of the block is Table.","$ref":"#/definitions/DocumentBodyTableWithHighlight"}}},"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":{"properties":{"description":"Properties for the UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListBlockProperties"},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentBodyListBlock"}}}},"DocumentBodyListBlock":{"type":"object","required":["blocks","type"],"properties":{"type":{"type":"string","description":"The type of the list block.","enum":["ListItem"]},"properties":{"description":"The properties for the list block.","$ref":"#/definitions/DocumentBodyListItemProperties"},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentListContentBlock"}}}},"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"]}}},"DocumentBodyListBlockWithHighlight":{"type":"object","required":["blocks","type"],"properties":{"type":{"type":"string","description":"The type of the list block.","enum":["ListItem"]},"properties":{"description":"The properties for the list block.","$ref":"#/definitions/DocumentBodyListItemProperties"},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentListContentBlockWithHighlight"}}}},"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"]}}},"DocumentBodyListWithHighlight":{"type":"object","required":["blocks"],"properties":{"properties":{"description":"Properties for the UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListBlockProperties"},"blocks":{"type":"array","description":"The list of items for an OrderedList or an UnorderedList.","items":{"$ref":"#/definitions/DocumentBodyListBlockWithHighlight"}}}},"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"}}},"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"}}},"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 of the table cell converted to em unit."},"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."}}},"DocumentBodyTableCellBlockWithHighlight":{"type":"object","required":["blocks"],"properties":{"properties":{"description":"The properties for the table cell.","$ref":"#/definitions/DocumentBodyTableCellBlockProperties"},"blocks":{"type":"array","description":"The list of content blocks for the table.","items":{"$ref":"#/definitions/DocumentTableContentBlockWithHighlight"}}}},"DocumentBodyTableProperties":{"type":"object","properties":{"width":{"type":"number","format":"float","description":"The width of the table converted to em unit."},"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"}}},"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"}}},"DocumentBodyTableRowBlockWithHighlight":{"type":"object","required":["cells"],"properties":{"properties":{"description":"The properties for the table rows.","$ref":"#/definitions/DocumentBodyTableRowBlockProperties"},"cells":{"type":"array","description":"The list of cells for the table.","items":{"$ref":"#/definitions/DocumentBodyTableCellBlockWithHighlight"}}}},"DocumentBodyTableWithHighlight":{"type":"object","required":["rows"],"properties":{"properties":{"description":"The properties for the table.","$ref":"#/definitions/DocumentBodyTableProperties"},"rows":{"type":"array","description":"The list of rows for the table.","items":{"$ref":"#/definitions/DocumentBodyTableRowBlockWithHighlight"}}}},"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."}}},"DocumentElementLength":{"type":"object","required":["unit","value"],"properties":{"value":{"type":"number","format":"float","description":"The length value of the element in the selected unit."},"unit":{"type":"string","description":"The unit of length.","enum":["Em","Percentage","Px"]}}},"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"},"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"}}},"DocumentListContentBlockWithHighlight":{"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"},"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/DocumentBodyListWithHighlight"},"answerHighlight":{"description":"The block highlight data.","$ref":"#/definitions/DocumentContentHighlightIndex"}}},"DocumentTableContentBlockWithHighlight":{"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"]},"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"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraphWithHighlight"},"list":{"description":"List. It must contain a value if the type of the block is UnorderedList or OrderedList.","$ref":"#/definitions/DocumentBodyListWithHighlight"},"table":{"description":"Table. It must contain a value if the type of the block is Table.","$ref":"#/definitions/DocumentBodyTableWithHighlight"},"answerHighlight":{"description":"The block highlight data.","$ref":"#/definitions/DocumentContentHighlightIndex"}}},"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"}}}},"KnowledgeAnswerDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The document id."},"title":{"type":"string","description":"The document title."},"answer":{"type":"string","description":"The answer found inside a variationContent."},"variation":{"description":"The variation with the answer's highlight data.","$ref":"#/definitions/DocumentVariationAnswer"}}},"KnowledgeAnswerDocumentsResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results with answers if the answerMode request property is not set or contains \"AnswerHighlight\". Empty array otherwise.","items":{"$ref":"#/definitions/KnowledgeAnswerDocumentResponse"}},"answerGeneration":{"description":"The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\".","$ref":"#/definitions/KnowledgeAnswerGenerationResponse"}}},"KnowledgeAnswerGenerationResponse":{"type":"object","properties":{"answer":{"type":"string","description":"The AI-generated answer."},"documents":{"type":"array","description":"The documents used for answer generation.","items":{"$ref":"#/definitions/AnswerGenerationDocument"}}}},"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}}},"KnowledgeDocumentsAnswerFilter":{"type":"object","required":["variationIds"],"properties":{"query":{"type":"string","description":"The search query."},"language":{"type":"string","description":"The language of the documents.","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"]},"appType":{"type":"string","description":"The appType","enum":["Assistant","BotFlow","MessengerKnowledgeApp","SmartAdvisor","SupportCenter"]},"queryType":{"type":"string","description":"The query type","enum":["Unknown","Article","AutoSearch","Category","ManualSearch","Recommendation","Suggestion"]},"searchId":{"type":"string","description":"The search id."},"insertHighlightIntoVariationContent":{"type":"boolean","description":"If specified - insert highlight data into the variation content."},"answerMode":{"type":"array","description":"Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight","items":{"type":"string","enum":["AnswerHighlight","AnswerGeneration"]}},"variationIds":{"type":"array","description":"The variation Ids to answer.","items":{"type":"string"},"maxItems":10,"minItems":1}}},"ContentFileResponse":{"type":"object","required":["checksum","contentUrl","name","size","type"],"properties":{"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The file format","enum":["Pdf","Docx","Doc"]},"checksum":{"type":"string","description":"The checksum of the file"},"size":{"type":"integer","format":"int64","description":"The size of the file in bytes"},"contentUrl":{"type":"string","description":"Public download url for content. Needs to be expanded"}}},"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"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"},"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"}}},"DocumentBodyResponse":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the document body.","items":{"$ref":"#/definitions/DocumentBodyBlock"}}}},"DocumentBodyTable":{"type":"object","required":["rows"],"properties":{"properties":{"description":"The properties for the table.","$ref":"#/definitions/DocumentBodyTableProperties"},"rows":{"type":"array","description":"The list of rows for the table.","items":{"$ref":"#/definitions/DocumentBodyTableRowBlock"}}}},"DocumentBodyTableCellBlock":{"type":"object","required":["blocks"],"properties":{"properties":{"description":"The properties for the table cell.","$ref":"#/definitions/DocumentBodyTableCellBlockProperties"},"blocks":{"type":"array","description":"The list of content blocks for the table.","items":{"$ref":"#/definitions/DocumentTableContentBlock"}}}},"DocumentBodyTableRowBlock":{"type":"object","required":["cells"],"properties":{"properties":{"description":"The properties for the table rows.","$ref":"#/definitions/DocumentBodyTableRowBlockProperties"},"cells":{"type":"array","description":"The list of cells for the table.","items":{"$ref":"#/definitions/DocumentBodyTableCellBlock"}}}},"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"]},"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"},"paragraph":{"description":"Paragraph. It must contain a value if the type of the block is Paragraph.","$ref":"#/definitions/DocumentBodyParagraph"},"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"}}},"DocumentVariationResponse":{"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/DocumentBodyResponse"},"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."}}},"KnowledgeDocumentDescriptor":{"type":"object","properties":{}},"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."},"externalUrl":{"type":"string","description":"The URL to external 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/DocumentVariationResponse"}},"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"}}},"KnowledgeDocumentCreateRequest":{"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}}},"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"}}}},"WritableEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object."}}},"ContentFileRequest":{"type":"object","properties":{"uploadKey":{"type":"string","description":"Key that identifies the file in the storage including the file name"},"name":{"type":"string","description":"The name of the file"}}},"DocumentBodyRequest":{"type":"object","required":["blocks"],"properties":{"blocks":{"type":"array","description":"The list of building blocks for the document body.","items":{"$ref":"#/definitions/DocumentBodyBlock"}}}},"DocumentVariationRequest":{"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/DocumentBodyRequest"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"DocumentVariationResponseListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/DocumentVariationResponse"}},"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/DocumentBodyResponse"},"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}}},"KnowledgeDocumentFeedbackUpdateRequest":{"type":"object","required":["rating"],"properties":{"rating":{"type":"string","description":"Feedback rating.","enum":["Negative","Positive"]},"reason":{"type":"string","description":"Feedback reason","enum":["DocumentContent","SearchResults"]},"comment":{"type":"string","description":"Feedback comment"},"state":{"type":"string","description":"Feedback state","enum":["Draft","Final"]}}},"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"}}},"KnowledgeDocumentQueryResponse":{"type":"object","properties":{"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"total":{"type":"integer","format":"int64","description":"The total number of documents matching the query.","readOnly":true},"pageCount":{"type":"integer","format":"int32","description":"The total number of pages of results, calculated according to the pageSize and the total matching documents.","readOnly":true},"results":{"type":"array","description":"Documents matching the query.","readOnly":true,"items":{"$ref":"#/definitions/KnowledgeDocumentResponse"}}}},"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"]}}},"KnowledgeDocumentQuery":{"type":"object","required":["filter"],"properties":{"pageSize":{"type":"integer","format":"int32","description":"Page size of the returned results."},"pageNumber":{"type":"integer","format":"int32","description":"Page number of the returned results."},"includeDraftDocuments":{"type":"boolean","description":"Indicates whether the 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 query.","$ref":"#/definitions/DocumentQuery"},"includeVariations":{"type":"string","description":"Indicates which document variations to include in returned documents. All: all variations regardless of the filter expression; AllMatching: all variations that match the filter expression; SingleMostRelevant: single variation that matches the filter expression and has the highest priority. The default is All.","enum":["All","AllMatching","SingleMostRelevant"]},"sortOrder":{"type":"string","description":"The sort order for results.","enum":["Asc","Desc"]},"sortBy":{"type":"string","description":"The field in the documents that you want to sort the results by.","enum":["DateCreated","DateModified","CategoryName","LabelName","ViewCount"]}}},"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"},"includeDocumentsWithFileBody":{"type":"boolean"}}},"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."}}},"SyncStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"New status for an existing sync operation","enum":["Created","ValidationInProgress","ValidationCompleted","ValidationFailed","Started","InProgress","Completed","PartialCompleted","Failed","AbortRequested","Aborted"]}}},"KnowledgeSyncJobRequest":{"type":"object","required":["uploadKey"],"properties":{"uploadKey":{"type":"string","description":"Upload key"},"sourceId":{"type":"string","description":"Knowledge integration source id."}}},"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}}},"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}}},"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."},"answerGeneration":{"description":"The results with AI-generated answer if the answerMode request property contains \"AnswerGeneration\".","$ref":"#/definitions/KnowledgeAnswerGenerationResponse"}}},"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."},"externalUrl":{"type":"string","description":"The URL to external 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},"answerMode":{"type":"array","description":"Allows extracted answers from an article (AnswerHighlight) and/or AI-generated answers (AnswerGeneration). Default mode: AnswerHighlight. Use this property with answerHighlightTopResults.","items":{"type":"string","enum":["AnswerHighlight","AnswerGeneration"]}}}},"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."},"description":{"type":"string","description":"The description 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":["AI","DynamicList","List","Regex","Unknown"]},"subType":{"type":"string","description":"Subtype of detection mechanism","enum":["Alphanumeric","NumberSequence","FreeForm"]},"maxLength":{"type":"integer","format":"int32","description":"The maximum length of the entity resolved value"},"examples":{"type":"array","description":"Examples for entity detection","items":{"$ref":"#/definitions/NamedEntityTypeMechanismExample"}}}},"NamedEntityTypeMechanismExample":{"type":"object","required":["resolvedValue","text"],"properties":{"text":{"type":"string","description":"Example input text"},"resolvedValue":{"type":"string","description":"Resolved entity value"}}},"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},"source":{"type":"string","description":"The source of the utterance.","enum":["Generated","User"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","it-it","nl-nl"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"LimitCount":{"type":"object","properties":{"name":{"type":"string","description":"The name of the limit."},"estimatedCount":{"type":"integer","format":"int64","description":"The total used count of the limit."},"max":{"type":"integer","format":"int64","description":"The maximum value of the limit."},"entityId":{"type":"string","description":"The entity which makes this count unique. The context of what the entity is would be dependant on the limit. May not be applicable for all limits."},"userId":{"type":"string","description":"The user which makes this count unique. May not be applicable for all limits."}}},"LimitCountListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/LimitCount"}},"nextUri":{"type":"string","description":"A URI to the next page in the listing."},"selfUri":{"type":"string","description":"A URI to the current page in the listing."}}},"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","business.rules","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gamification","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","internal.messaging","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","business.rules","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gamification","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","internal.messaging","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","business.rules","callback","cobrowse","content.management","conversation","dataactions","datatables","directory","email","employee.engagement","event.orchestration","external.contacts","gamification","gcv","gdpr","groups","historical.adherence","infrastructureascode","integrations","intent.miner","internal.messaging","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":{"name":{"type":"string"},"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":{"name":{"type":"string"},"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},"dateStarted":{"type":"string","format":"date-time","description":"Indicates when log capture was enabled for the user. 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":"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."},"contentSizeBytes":{"type":"integer","format":"int64","description":"Size in bytes of the attachment content."}},"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","Share","Comment","View"]},"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","Topic"]},"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},"externalContactId":{"type":"string","description":"The identifier of the external contact."},"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","Topic","IngestionRule","IngestionRuleVersion"]},"value":{"type":"string","description":"The Identifier value.","readOnly":true}},"description":"Additional identifiers for describing messaging recipient."},"IpAddressRange":{"type":"object","properties":{"cidr":{"type":"string"},"service":{"type":"string","enum":["data-actions","smtp","audiohook","open-messaging","api","audio-connector","byot-stt","bot-connector"]},"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."}}},"ResponsePage":{"type":"object","required":["domain","hostname","pathname","title","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 tag of the page."},"lang":{"type":"string","description":"ISO 639-1 language code for the page as defined in the 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."}}},"WebEventBrowser":{"type":"object","required":["family","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."}}},"WebEventDevice":{"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."},"osFamily":{"type":"string","description":"Operating system family."},"osVersion":{"type":"string","description":"Operating system version."},"manufacturer":{"type":"string","description":"Manufacturer of the device."}}},"WebEventResponse":{"type":"object","required":["attributes","authenticated","browser","createdDate","customerId","customerIdType","device","eventName","page","session","traits","userAgentString"],"properties":{"customerId":{"type":"string","description":"Identifier of the customer in the source of the event."},"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. page_viewed, order_completed, user_registered."},"customerIdType":{"type":"string","description":"Type of identifier for the customer ID (e.g., cookie)."},"page":{"description":"The webpage where the user interaction occurred.","$ref":"#/definitions/ResponsePage"},"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/WebEventBrowser"},"device":{"description":"Customer's device.","$ref":"#/definitions/WebEventDevice"},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"ipOrganization":{"type":"string","description":"Customer's IP-based organization or ISP name."},"geolocation":{"description":"Customer's geolocation.","$ref":"#/definitions/JourneyGeolocation"},"mktCampaign":{"description":"Urchin Tracking Module (UTM) parameters used to track the effectiveness of online marketing campaigns.","$ref":"#/definitions/JourneyCampaign"},"session":{"description":"The session that the event belongs to.","$ref":"#/definitions/WebEventResponseSession"},"referrer":{"description":"Identifies the web page 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. 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"}},"authenticated":{"type":"boolean","description":"Indicates whether the event was produced during an authenticated session."},"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"}}},"WebEventResponseSession":{"type":"object","required":["createdDate","durationInSeconds","eventCount","pageviewCount"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"durationInSeconds":{"type":"integer","format":"int32","description":"Indicates how long the customer has been on the site within this session."},"eventCount":{"type":"integer","format":"int32","description":"The count of all events recorded during this session."},"pageviewCount":{"type":"integer","format":"int32","description":"The count of all pageviews performed during this session."},"referrer":{"description":"The referrer of the first event in the web session.","$ref":"#/definitions/Referrer"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true},"createdDate":{"type":"string","format":"date-time","description":"Date 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"}}},"RequestPage":{"type":"object","required":["title","url"],"properties":{"url":{"type":"string","description":"The page URL."},"title":{"type":"string","description":"Title of the page."},"keywords":{"type":"string","description":"Keywords from the HTML tag of the page."},"lang":{"type":"string","description":"ISO 639-1 language code for the page as defined in the tag."}}},"WebEventRequest":{"type":"object","required":["createdDate","customerCookieId","eventName","page"],"properties":{"customerCookieId":{"type":"string","description":"A UUID representing the customer making the request."},"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. page_viewed, order_completed, user_registered."},"page":{"description":"The webpage where the user interaction occurred.","$ref":"#/definitions/RequestPage"},"userAgentString":{"type":"string","description":"Override for HTTP User-Agent string from request header (see https://tools.ietf.org/html/rfc1945#section-10.15)."},"browser":{"description":"Customer's browser.","$ref":"#/definitions/WebEventBrowser"},"device":{"description":"Customer's device.","$ref":"#/definitions/WebEventDevice"},"searchQuery":{"type":"string","description":"Represents the keywords in a customer search query."},"ipAddress":{"type":"string","description":"Customer's IP address."},"referrerUrl":{"type":"string","description":"Identifies the referrer URL that originally generated the request for the current page being viewed."},"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"}},"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"}}},"KnowledgeGuestAnswerDocumentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The document id."},"title":{"type":"string","description":"The document title."},"answer":{"type":"string","description":"The answer found inside a variationContent."},"variation":{"description":"The variation with the answer's highlight data.","$ref":"#/definitions/KnowledgeGuestDocumentVariationAnswer"}}},"KnowledgeGuestAnswerDocumentsResponse":{"type":"object","properties":{"results":{"type":"array","description":"The results with answers.","items":{"$ref":"#/definitions/KnowledgeGuestAnswerDocumentResponse"}}}},"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/DocumentBodyResponse"},"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"}},"journeySessionId":{"type":"string","description":"Journey session ID. Used to get the segments of the customer to filter search results."}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"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"}}}},"EventQueryResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/OperationalEvent"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"OperationalEvent":{"type":"object","properties":{"eventDefinition":{"description":"The event that occurred.","$ref":"#/definitions/AddressableEntityRef"},"entityId":{"type":"string","description":"The unique identifier for the entity"},"entityName":{"type":"string","description":"The name for the entity"},"previousValue":{"type":"string","description":"The value prior to the event"},"currentValue":{"type":"string","description":"The changed value following the event"},"errorCode":{"type":"string","description":"The error code of the entity in the providing service associated to the event"},"parentEntityId":{"type":"string","description":"The unique identifier for the parent of the entity"},"conversation":{"description":"The link to a conversation","$ref":"#/definitions/AddressableEntityRef"},"dateCreated":{"type":"string","format":"date-time","description":"The date when the event created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"entityVersion":{"type":"string","description":"The version of the entity in the providing service"}}},"EventQueryRequest":{"type":"object","required":["interval"],"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"},"eventDefinitionIds":{"type":"array","description":"Filter events by a list of event definition ids","items":{"type":"string"}},"searchTerm":{"type":"string","description":"Only return events that contain the search term"},"sortOrder":{"type":"string","description":"Order of results. Default order is DESC.","enum":["ASC","DESC"]}}},"EventAggregatesResponse":{"type":"object","properties":{"interval":{"type":"string","description":"Interval for returned aggregates. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss"},"eventDefinitionAggregates":{"type":"array","description":"Aggregates by event definition","items":{"$ref":"#/definitions/EventDefinitionAggregates"}}}},"EventDefinitionAggregates":{"type":"object","properties":{"eventDefinition":{"description":"Event definition.","$ref":"#/definitions/AddressableEntityRef"},"eventCount":{"type":"integer","format":"int32","description":"How many events have occurred."}}},"EventAggregatesQueryRequest":{"type":"object","required":["interval"],"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"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"hasFullAccess":{"type":"boolean","description":"Denotes if trustee uses full access role by default."},"isTrustedUser":{"type":"boolean","description":"Denotes if trustee is given Trusted User access 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}}},"TrusteeReferenceList":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"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/Image"}},"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"},"includeOwners":{"type":"boolean","description":"Allow owners to be included as members of the group"},"callsEnabled":{"type":"boolean","description":"Allow calls to be placed 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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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/Image"}},"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"},"workPlanBidRanks":{"description":"The WFM work plan bid rank settings for the user","readOnly":true,"$ref":"#/definitions/WorkPlanBidRanks"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"label":{"description":"This specifies the interaction label scoped to this estimated wait time calculation","$ref":"#/definitions/AddressableEntityRef"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"TriggerEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Trigger"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"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."}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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":{"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"}}},"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, this includes both success and error results. This number could change as recordings are being discovered and processed."},"resultCount":{"type":"integer","format":"int32","description":"Current number of results available, this includes both success and error results."},"errorCount":{"type":"integer","format":"int32","description":"Current number of error results."},"status":{"type":"string","description":"Current status of the job. A job is considered completed when all the submitted requests have been processed and fulfilled.","enum":["InProgress","Completed"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"}}}},"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"}}}},"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"]},"evaluationSettings":{"description":"Settings for evaluations associated with this form","$ref":"#/definitions/EvaluationSettings"},"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"},"revisionCreatedDate":{"type":"string","format":"date-time","description":"Date of when evaluation revision is created. Null if there is no revision. 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","INTERNAL_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"},"surveyType":{"type":"string","description":"Type of the survey","enum":["Web","Voice"]},"missingRequiredAnswer":{"type":"boolean","description":"True if any of the required questions for the survey form have not been answered. Null if survey is not finished."},"flow":{"description":"An Architect flow that executed in order to collect the answers for this survey.","$ref":"#/definitions/AddressableEntityRef"},"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","mediaType","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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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,Pause","readOnly":true,"enum":["Hold","SecurePause","FlowOrQueue","Pause"]},"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","DatePicker","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/Image"}}}},"EmailAttachment":{"type":"object","properties":{"name":{"type":"string"},"contentPath":{"type":"string"},"contentType":{"type":"string"},"attachmentId":{"type":"string"},"contentLength":{"type":"integer","format":"int32"}}},"GenericTemplate":{"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."},"components":{"type":"array","description":"List of button components offered with this message content.","items":{"$ref":"#/definitions/RecordingButtonComponent"}},"actions":{"description":"Actions to be taken.","$ref":"#/definitions/RecordingContentActions"}}},"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"}}},"RecordingAttachment":{"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.","enum":["Image","Video","Audio","File","Link"]},"url":{"type":"string","description":"URL of the attachment."},"mime":{"type":"string","description":"Attachment mime type."},"text":{"type":"string","description":"Text associated with attachment such as an image caption."},"fileName":{"type":"string","description":"Suggested file name for attachment."}}},"RecordingButtonComponent":{"type":"object","properties":{"title":{"type":"string"},"actions":{"$ref":"#/definitions/RecordingContentActions"},"isSelected":{"type":"boolean"}},"description":"Structured template button object."},"RecordingContentActions":{"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 sent back in reply when the item is selected."}},"description":"User actions available on the content. All actions are optional and all actions are executed simultaneously."},"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"]}}},"RecordingNotificationTemplate":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"language":{"type":"string","description":"Template language."},"header":{"description":"The template header.","$ref":"#/definitions/RecordingTemplateHeader"},"body":{"description":"The template body.","$ref":"#/definitions/RecordingTemplateBody"},"buttons":{"type":"array","description":"Template buttons","items":{"$ref":"#/definitions/RecordingTemplateButton"}},"footer":{"description":"The template footer.","$ref":"#/definitions/RecordingTemplateFooter"}}},"RecordingTemplateBody":{"type":"object","properties":{"text":{"type":"string","description":"Template parameters for placeholders in template."}}},"RecordingTemplateButton":{"type":"object","properties":{"type":{"type":"string","description":"Specifies the type of the button.","enum":["QuickReply","PhoneNumber","Url"]},"text":{"type":"string","description":"Button text message."},"index":{"type":"integer","format":"int64","description":"Index of the button in the list."},"phoneNumber":{"type":"string","description":"Button phone number."},"url":{"type":"string","description":"Button URL link."},"isSelected":{"type":"boolean","description":"Indicates if the button is selected by end customer."}}},"RecordingTemplateFooter":{"type":"object","properties":{"text":{"type":"string","description":"Footer text."}}},"RecordingTemplateHeader":{"type":"object","properties":{"type":{"type":"string","description":"Template header type.","enum":["Text","Media"]},"text":{"type":"string","description":"Header text."},"media":{"description":"Media template header image.","$ref":"#/definitions/RecordingAttachment"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"recordingPlaybackUrlTtl":{"type":"integer","format":"int32","description":"The duration in minutes for which the generated URL for recording playback remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes."},"recordingBatchDownloadUrlTtl":{"type":"integer","format":"int32","description":"The duration in minutes for which the generated URL for recording batch download remains valid.The default duration is set to 60 minutes, with a minimum allowable duration of 2 minutes and a maximum of 60 minutes."}}},"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"}}}},"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"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"CommonRuleBulkDeleteRequest":{"type":"object","required":["ruleIds"],"properties":{"ruleIds":{"type":"array","description":"The user supplied rule ids to be deleted","items":{"type":"string"}}}},"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"]}}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}}},"Button":{"type":"object","properties":{}},"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"},"MessageFooter":{"type":"object","properties":{}},"MessageHeader":{"type":"object","properties":{}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"]},"type":{"type":"string","description":"Response text type.","enum":["body","subject"]}},"description":"Contains information about the text associated with a response."},"WhatsAppDefinition":{"type":"object","required":["language","name"],"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."},"pageNumber":{"type":"integer","format":"int32","description":"Page Number"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"cannedResponseLibraries":{"description":"Canned response library IDs and mode with which they are associated with the queue","$ref":"#/definitions/CannedResponseLibraries"},"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":{"description":"The default email address to use for outbound email from this queue.","$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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"},"cannedResponseLibraries":{"description":"Canned response library IDs and mode with which they are associated with the queue","$ref":"#/definitions/CannedResponseLibraries"},"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":{"description":"The default email address to use for outbound email from this queue.","$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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"cannedResponseLibraries":{"description":"Canned response library IDs and mode with which they are associated with the queue","$ref":"#/definitions/CannedResponseLibraries"},"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":{"description":"The default email address to use for outbound email from this queue.","$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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"label":{"description":"Current label on in-queue conversation","$ref":"#/definitions/UtilizationLabel"},"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., \"\"."},"labelId":{"type":"string","description":"Label requirement for the conversation. To remove the label requirement (setting it to System Default Label), 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}}},"GraphApiSettings":{"type":"object","properties":{"integration":{"description":"The Graph API server integration to use for emails.","$ref":"#/definitions/DomainEntityRef"},"status":{"type":"string","description":"Graph API Server Status","readOnly":true,"enum":["Active","Error","Inactive","IntegrationDeleted","Unknown"]},"errorInfo":{"description":"Additional Graph API Server error information","readOnly":true,"$ref":"#/definitions/EmailErrorInfo"}}},"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"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"]}},"worktypeId":{"type":"string"},"virtualAgentEnabled":{"type":"boolean"},"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"},"virtualAgentEnabled":{"type":"boolean"},"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"},"description":{"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","whatsapp","webmessaging","instagram","open","apple"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"AgentDirectRoutingBackupSettings":{"type":"object","properties":{"queueId":{"type":"string","description":"ID of queue to be used as backup. If queueId and userId are both specified, queue behaves as secondary backup."},"userId":{"type":"string","description":"ID of user to be used as backup. If queueId and userId are both specified, user behaves as primary backup."},"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]."},"backedUpUsers":{"type":"array","description":"Set of users that this user is a backup for.","readOnly":true,"uniqueItems":true,"items":{"type":"string"}}}},"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"},"description":{"type":"string","description":"The wrap-up code description."},"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."},"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."},"dateHire":{"type":"string","description":"The user's hire date. Format in JSON will be YYYY-MM-DD."}},"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."},"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."},"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"]}}}},"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"}}}},"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"topicLinksJob":{"$ref":"#/definitions/AddressableEntityRef"},"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"}}}},"DeleteProgramResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"topicLinksJob":{"$ref":"#/definitions/AddressableEntityRef"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ProgramsMappingsEntityListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ProgramMappings"}},"pageSize":{"type":"integer","format":"int32"},"selfUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"},"nextUri":{"type":"string","format":"uri"}}},"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"},"pageCount":{"type":"integer","format":"int32"},"nextUri":{"type":"string","format":"uri"}}},"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"canonicalId":{"type":"string","description":"Canonical identifier for this time zone, if applicable"},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"AlertablePresences":{"type":"object","required":["alertablePresences"],"properties":{"alertablePresences":{"type":"array","description":"The list of alertable system presences.","items":{"type":"string","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]}}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SitesSearchResponse":{"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/Site"}}}},"SiteSearchCriteria":{"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/SiteSearchCriteria"}},"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","CONTAINS"]},"fields":{"type":"array","description":"Field names to search against","items":{"type":"string"}}}},"SiteSearchRequest":{"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/SiteSearchCriteria"}}}},"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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}}},"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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":"Whether or not the job was a dry run"},"acceleratorId":{"type":"string","description":"Accelerator associated with the job","readOnly":true},"dateSubmitted":{"type":"string","format":"date-time","description":"Date and time on which job was submitted. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z","readOnly":true},"submittedBy":{"description":"User who submitted the job","readOnly":true,"$ref":"#/definitions/UserReference"},"status":{"type":"string","description":"Job status","readOnly":true,"enum":["Created","Queued","Running","Complete","InternalError","Incomplete","Failed","RollbackFailed","RollbackComplete"]},"errorInfo":{"description":"Information about errors, if any","readOnly":true,"$ref":"#/definitions/ErrorInfo"},"results":{"type":"string","description":"The output results of the terraform job","readOnly":true},"rollbackResults":{"type":"string","description":"The results of rolling back the job if there were errors. Not returned if job was successful.","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","Open","Instagram","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","GenesysDigitalBotFlow","GenesysVoiceSurveyFlow"]},"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},"includeBadge":{"type":"boolean","description":"includeBadge","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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"ChatFavorite":{"type":"object","required":["externalId","id"],"properties":{"id":{"type":"string","description":"The guid id of the favorite"},"externalId":{"type":"string","description":"The external id of the favorite"}}},"ChatItem":{"type":"object","required":["chatType","open"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"open":{"type":"boolean","description":"If the chat is open"},"favorite":{"description":"The favorite entity for the chat, only appears if the chat is favorited","$ref":"#/definitions/ChatFavorite"},"images":{"type":"array","description":"Avatar images for the chat","items":{"$ref":"#/definitions/Image"}},"dateLastMessage":{"type":"string","format":"date-time","description":"The date of the last message. 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 chat was closed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"user":{"description":"The other 1on1 user","$ref":"#/definitions/ChatUserRef"},"room":{"description":"The room of the chat","$ref":"#/definitions/Room"},"chatType":{"type":"string","description":"The type of chat","enum":["adhoc","acd","group","oneOnOne","supervisorAssistance"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ChatItemCursorListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ChatItem"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"}}},"ChatPresence":{"type":"object","properties":{"source":{"type":"string"},"organizationPresence":{"$ref":"#/definitions/OrganizationPresence"},"systemPresence":{"type":"string","enum":["Available","Away","Busy","Offline","Idle","OnQueue","Meal","Training","Meeting","Break"]},"message":{"type":"string"},"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"},"outOfOffice":{"$ref":"#/definitions/OutOfOffice"}}},"ChatUserRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"selfUri":{"type":"string","format":"uri"},"jid":{"type":"string"},"inactive":{"type":"boolean"},"integrations":{"type":"array","items":{"$ref":"#/definitions/Contact"}},"presence":{"$ref":"#/definitions/ChatPresence"}}},"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/Image"}},"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"},"workPlanBidRanks":{"description":"The WFM work plan bid rank settings for the user","readOnly":true,"$ref":"#/definitions/WorkPlanBidRanks"},"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"}},"autoAnswerSettings":{"description":"Auto answer settings for this user","readOnly":true,"$ref":"#/definitions/AutoAnswerSettings"},"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/Image"}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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},"transcription":{"type":"string","description":"The transcription of the voicemail's audio","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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}}},"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."}}},"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}}},"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","Export"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","DECISIONTABLE","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","SMSPHONENUMBER","STTENGINE","SURVEYFORM","SURVEYINVITEFLOW","SYSTEMPROMPT","TTSENGINE","TTSVOICE","USER","USERPROMPT","UTILIZATIONLABEL","VOICEFLOW","VOICEMAILFLOW","VOICESURVEYFLOW","WIDGET","WORKFLOW","WORKITEMFLOW","WORKTYPE"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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"]}}},"WorkitemRuleAction":{"type":"object","properties":{"type":{"type":"string","enum":["LaunchFlow"]}}},"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}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"virtualAgentEnabled":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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}}},"GrammarFileUploadRequest":{"type":"object","properties":{"fileType":{"type":"string","enum":["gram","grxml"]}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"totalNumberOfEntities":{"type":"integer","format":"int64","description":"The total organization-wide number of entities."},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"allowDraw":{"type":"boolean","description":"Should cobrowse draw be enabled"},"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"},"notifications":{"description":"The notification settings for messenger apps","$ref":"#/definitions/NotificationsSettings"}},"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 are 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"},"sessionPersistenceType":{"type":"string","description":"The session persistence type for messenger","enum":["AcrossSubdomains","DomainOrSubdomainOnly"]}},"description":"Settings concerning messenger"},"MessengerStyles":{"type":"object","properties":{"primaryColor":{"type":"string","example":"#a7017c","description":"The primary color of messenger in hexadecimal"}}},"NotificationsSettings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"The toggle to enable or disable notifications"}},"description":"Notification settings that handles messenger notifications"},"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"}}},"SupportCenterLabelFilter":{"type":"object","properties":{"labels":{"type":"array","description":"Labels to filter by.","items":{"$ref":"#/definitions/AddressableEntityRef"}}}},"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"}},"labelFilter":{"description":"Document label filter. If set, only documents having at least one of the specified labels will be returned by knowledge document query operations.","$ref":"#/definitions/SupportCenterLabelFilter"},"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":{"entities":{"type":"array","items":{"$ref":"#/definitions/WebDeploymentConfigurationVersion"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"total":{"type":"integer","format":"int64"}}},"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/WebDeploymentFlowEntityRef"},"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"}}},"WebDeploymentFlowEntityRef":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Flow ID"},"name":{"type":"string","description":"The Flow name"},"selfUri":{"type":"string","format":"uri"},"flowDescription":{"type":"string","description":"The flow description for the webdeployment"},"publishVersion":{"description":"The published config version for the associated deployment","$ref":"#/definitions/FlowVersion"}}},"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/WebDeploymentFlowEntityRef"},"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":{"entities":{"type":"array","items":{"$ref":"#/definitions/ExpandableWebDeployment"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"total":{"type":"integer","format":"int64"}}},"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."},"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","Workitem"]},"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","Workitem"]},"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"}}},"ActivityCodeReference":{"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}}},"BuActivitySettingsResponse":{"type":"object","properties":{"defaultActivityCode":{"description":"Default Activity Code settings","$ref":"#/definitions/ActivityCodeReference"}}},"BuNotificationSettingsResponse":{"type":"object","properties":{"scheduling":{"description":"Schedule notification settings","$ref":"#/definitions/BuScheduleNotificationsSettingsResponse"}}},"BuScheduleNotificationsCategorySettings":{"type":"object","required":["activityCategory","earlyReminderEnabled","onTimeReminderEnabled"],"properties":{"activityCategory":{"type":"string","description":"The activity category","enum":["OnQueueWork","Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable","Unscheduled"]},"earlyReminderEnabled":{"type":"boolean","description":"Indicates if agents should receive early schedule reminder notifications."},"onTimeReminderEnabled":{"type":"boolean","description":"Indicates if agents should receive out of adherence notifications."}}},"BuScheduleNotificationsSettingsResponse":{"type":"object","required":["activityCategorySettings","earlyReminderMinutes"],"properties":{"earlyReminderMinutes":{"type":"integer","format":"int32","description":"The number of minutes prior to the scheduled event to display an early reminder notification"},"activityCategorySettings":{"type":"array","description":"List of activity category notification settings","items":{"$ref":"#/definitions/BuScheduleNotificationsCategorySettings"}}}},"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"]}}},"BuActivitySettingsRequest":{"type":"object","properties":{"defaultActivityCodeId":{"type":"string","description":"The ID of the activity code. This is the activity code that will be used by default for agent development activities added to the schedule"}}},"BuNotificationSettingsRequest":{"type":"object","properties":{"scheduling":{"description":"Schedule notification settings","$ref":"#/definitions/BuScheduleNotificationsSettingsRequest"}}},"BuScheduleNotificationsSettingsRequest":{"type":"object","properties":{"earlyReminderMinutes":{"type":"integer","format":"int32","description":"The number of minutes prior to the scheduled event to display an early reminder notification"},"activityCategorySettings":{"type":"array","description":"List of activity category notification settings","items":{"$ref":"#/definitions/BuScheduleNotificationsCategorySettings"}}}},"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"},"firstUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"lastUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"pageCount":{"type":"integer","format":"int32","description":"Deprecated, paging is not supported"},"nextUri":{"type":"string","format":"uri","description":"Deprecated, paging is not supported"},"previousUri":{"type":"string","format":"uri","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"}}},"MonthlyPlanningPeriodSettings":{"type":"object","required":["startDate"],"properties":{"startDate":{"type":"string","format":"date","description":"Start date of the monthly planning period in yyyy-MM-dd format. The date must represent the first day of the given month. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"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"}}},"ValueWrapperMonthlyPlanningPeriodSettings":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/MonthlyPlanningPeriodSettings"}}},"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 initiating shift 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"}}}},"AgentWorkPlans":{"type":"object","required":["user","workPlanLookupKeysPerWeek"],"properties":{"user":{"description":"The user (agent) for whom the work plans were requested","$ref":"#/definitions/UserReference"},"workPlanLookupKeysPerWeek":{"type":"array","description":"The list of weekly work plan lookup keys. Keys to be searched under workPlanLookup property at top level of result","items":{"type":"integer","format":"int32"}}}},"AgentsWorkPlansResponse":{"type":"object","properties":{"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"},"result":{"description":"The result of agent(s) work plans query","$ref":"#/definitions/MuAgentsWorkPlansResult"}}},"MuAgentsWorkPlansResult":{"type":"object","required":["referenceStartWeekDate","workPlanLookup"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentWorkPlans"}},"referenceStartWeekDate":{"type":"string","format":"date","description":"The reference date in yyyy-MM-dd format rolled back to nearest BU start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"workPlanLookup":{"type":"object","description":"Map containing lookup values for agent work plans. The integer keys serves as lookup keys for effective work plan from workPlanLookupKeysPerWeek property","additionalProperties":{"$ref":"#/definitions/WorkPlanReference"}}}},"GetAgentsWorkPlansRequest":{"type":"object","required":["agentIds","startDate","weekCount"],"properties":{"agentIds":{"type":"array","description":"The list of agent IDs","items":{"type":"string"}},"startDate":{"type":"string","format":"date","description":"The start of a date in yyyy-MM-dd format. Response contains values rolled back to nearest BU start day of week. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The number of weeks to query"}}},"UpdateMuAgentWorkPlanFailureResponse":{"type":"object","required":["failure","user"],"properties":{"user":{"description":"The user for whom the work plan update has failed","$ref":"#/definitions/UserReference"},"failure":{"type":"string","description":"The work plan update failure reason","enum":["AgentNotInManagementUnit","OverlappingOverride","OverrideNotFound","TooManyOverrides","WorkPlanNotFound"]},"notFoundWorkPlanId":{"type":"string","description":"The id of the work plan that has not been found"}}},"UpdateMuAgentWorkPlansBatchResponse":{"type":"object","required":["failures"],"properties":{"failures":{"type":"array","description":"The work plan update failures","items":{"$ref":"#/definitions/UpdateMuAgentWorkPlanFailureResponse"}}}},"UpdateMuAgentWorkPlanRequest":{"type":"object","required":["userId"],"properties":{"userId":{"type":"string","description":"The agent id for whom the work plan is updated"},"workPlanId":{"description":"The current work plan ID for the agent","$ref":"#/definitions/ValueWrapperString"},"workPlanOverrides":{"description":"The list of work plan overrides for the agent","$ref":"#/definitions/WorkPlanOverrideListWrapperWorkPlanOverrideRequest"}}},"UpdateMuAgentWorkPlansBatchRequest":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/UpdateMuAgentWorkPlanRequest"}}}},"ValueWrapperString":{"type":"object","properties":{"value":{"type":"string","description":"The value for the associated field"}}},"WorkPlanOverrideListWrapperWorkPlanOverrideRequest":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/WorkPlanOverrideRequest"}},"deleteAll":{"type":"boolean","description":"if true, should delete all existing overrides for the agent and update the given overrides"}}},"WorkPlanOverrideRequest":{"type":"object","required":["startDate"],"properties":{"action":{"type":"string","description":"The action to perform on work plan override, defaults to add","enum":["Add","Update","Delete"]},"startDate":{"type":"string","format":"date","description":"The start date in yyyy-MM-dd format for the updated work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"weekCount":{"type":"integer","format":"int32","description":"The week count of the updated work plan, required if action is Add or Update"},"workPlanId":{"type":"string","description":"The updated work plan id"}}},"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","Workitem"]},"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 with the initiating shift in the given week"}}},"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}}},"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}}},"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"}}},"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}}},"StaffingGroupListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/StaffingGroupResponse"}}}},"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"}}},"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}}},"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"}}},"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"}}}},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","OverlapsRestrictedActivityCode"]},"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","OverlapsRestrictedActivityCode"]},"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","OverlapsRestrictedActivityCode"]}},"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}}},"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}}},"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"}}},"WorkPlanRotationListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanRotationResponse"}}}},"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"}}},"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"}}},"ActivityPlanJobException":{"type":"object","required":["exceptionType","occurrences"],"properties":{"exceptionType":{"type":"string","description":"The type of error","enum":["UnscheduledAttendees","SessionsNotDeleted"]},"occurrences":{"type":"array","description":"The occurrences in which this error occurred","items":{"$ref":"#/definitions/ActivityPlanOccurrenceReference"}}}},"ActivityPlanJobListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActivityPlanJobResponse"}}}},"ActivityPlanJobResponse":{"type":"object","required":["activityPlan","exceptions","status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"activityPlan":{"description":"The activity plan associated with this job","$ref":"#/definitions/ActivityPlanReference"},"status":{"type":"string","description":"The status of the job","enum":["Processing","Complete","Error"]},"exceptions":{"type":"array","description":"The list of exceptions that occurred while running this activity plan job. These are exceptions that affect individual occurrences but didn't prevent the job from completing","items":{"$ref":"#/definitions/ActivityPlanJobException"}},"error":{"description":"Error details if status == 'Error'. These are errors that caused the job to fail to complete","$ref":"#/definitions/ErrorBody"},"occurrence":{"description":"The occurrence associated with this job if type == 'DeleteOccurrence'","$ref":"#/definitions/ActivityPlanOccurrenceReference"},"type":{"type":"string","description":"The type of the job","enum":["RunPlan","DeleteOccurrence"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActivityPlanOccurrenceReference":{"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}}},"ActivityPlanReference":{"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}}},"ActivityPlanListItem":{"type":"object","required":["activityCode","createdBy","createdDate","description","modifiedBy","modifiedDate","name","optimizationObjective","state","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the activity plan"},"managementUnits":{"type":"array","description":"The management units to which this activity plan applies. Empty list or null means this activity plan applies to all management units in the business unit","items":{"$ref":"#/definitions/ManagementUnitReference"}},"description":{"type":"string","description":"The description of this activity plan"},"activityCode":{"description":"The activity code to which this activity plan applies. Note: It is recommended to load and cache the entire list of activity codes rather than look up individual codes","$ref":"#/definitions/ActivityCodeReference"},"type":{"type":"string","description":"The type of the activity plan","enum":["Individual","Group"]},"optimizationObjective":{"type":"string","description":"The optimization objective of this activity plan","enum":["FavorServiceGoals","FavorSchedulingAll"]},"recurrenceSettings":{"description":"Recurrence settings for this activity plan","$ref":"#/definitions/RecurrenceSettings"},"state":{"type":"string","description":"The state of this activity plan","enum":["Active","Inactive"]},"lastRunDate":{"type":"string","format":"date-time","description":"The date the activity plan was last run, in ISO-8601 format"},"lastRunBy":{"description":"The last user to run this activity plan","$ref":"#/definitions/UserReference"},"createdDate":{"type":"string","format":"date-time","description":"The date the activity plan was created, in ISO-8601 format"},"createdBy":{"description":"The user who created this activity plan","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the activity plan was modified, in ISO-8601 format"},"modifiedBy":{"description":"The last user to modify this activity plan","$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActivityPlanListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/ActivityPlanListItem"}}}},"RecurrenceEndSettings":{"type":"object","properties":{"lastDate":{"type":"string","format":"date-time","description":"The end date of the recurrence for the activity plan, in ISO-8601 format. Only one of lastDate or noEndDate may be set"},"noEndDate":{"type":"boolean","description":"Whether this activity plan should continue indefinitely. If set to true, lastDate must not be set"}}},"RecurrencePeriod":{"type":"object","required":["granularity","magnitude"],"properties":{"magnitude":{"type":"integer","format":"int32","description":"The period of the activity plan in granularity units"},"granularity":{"type":"string","description":"The granularity unit to interpret the period of this activity plan","enum":["Days","Weeks"]}}},"RecurrenceSettings":{"type":"object","required":["endAfter","minimumTimeBetweenOccurrences","recurrencePeriod"],"properties":{"recurrencePeriod":{"description":"The recurrence period of the activity plan","$ref":"#/definitions/RecurrencePeriod"},"minimumTimeBetweenOccurrences":{"description":"Constraint indicating the minimum time in hours between recurrences of the activity plan","$ref":"#/definitions/RecurrencePeriod"},"endAfter":{"description":"Settings controlling when to end the recurrence for the activity plan","$ref":"#/definitions/RecurrenceEndSettings"}}},"ActivityPlanAbandonRateImpactOverride":{"type":"object","required":["increaseByPercent"],"properties":{"increaseByPercent":{"type":"number","format":"double","description":"Allowed abandon rate increase percent, from 0.0 to 100.0"}}},"ActivityPlanAsaImpactOverride":{"type":"object","required":["increaseByPercent"],"properties":{"increaseByPercent":{"type":"number","format":"double","description":"Allowed average speed of answer increase percent, from 0.0 to 100.0"}}},"ActivityPlanResponse":{"type":"object","required":["activityCode","countsAsPaidTime","createdBy","createdDate","description","facilitated","initialSchedulePeriod","lengthMinutes","modifiedBy","modifiedDate","name","optimizationObjective","state","transitionTimeMinutes","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name of the activity plan"},"managementUnits":{"type":"array","description":"The management units to which this activity plan applies. Empty list or null means this activity plan applies to the entire business unit","items":{"$ref":"#/definitions/ManagementUnitReference"}},"description":{"type":"string","description":"The description of this activity plan"},"activityCode":{"description":"The activity code associated with this activity plan. It is recommended to load and cache the entire list of activity codes rather than look up individual codes","$ref":"#/definitions/ActivityCodeReference"},"type":{"type":"string","description":"The type of the activity plan","enum":["Individual","Group"]},"initialSchedulePeriod":{"description":"The initial schedule period of the activity plan","$ref":"#/definitions/SchedulingPeriod"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of the activity in minutes"},"groupSettings":{"description":"Group settings for this activity plan","$ref":"#/definitions/GroupSettings"},"recurrenceSettings":{"description":"Recurrence settings for this activity plan","$ref":"#/definitions/RecurrenceSettings"},"attendeesSearchRule":{"description":"Attendee search rule for this activity plan","$ref":"#/definitions/UserSearchRule"},"facilitated":{"type":"boolean","description":"Whether the sessions created by this activity plan should be facilitated"},"facilitatorsSearchRule":{"description":"Facilitator search rule for this activity plan","$ref":"#/definitions/UserSearchRule"},"transitionTimeMinutes":{"type":"integer","format":"int32","description":"Transition time in minutes between facilitated sessions"},"serviceGoalImpactOverrides":{"description":"Allowable service goal impact override settings for this activity plan","$ref":"#/definitions/ActivityPlanServiceGoalImpactOverrides"},"optimizationObjective":{"type":"string","description":"The optimization objective of this activity plan","enum":["FavorServiceGoals","FavorSchedulingAll"]},"fixedAvailability":{"type":"array","description":"Fixed availability configuration for this activity plan","items":{"$ref":"#/definitions/FixedAvailability"}},"state":{"type":"string","description":"The state of this activity plan","enum":["Active","Inactive"]},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity should count as paid time"},"createdDate":{"type":"string","format":"date-time","description":"The date the activity plan was created, in ISO-8601 format"},"createdBy":{"description":"The user who created this activity plan","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The date the activity plan was modified, in ISO-8601 format"},"modifiedBy":{"description":"The last user to modify this activity plan","$ref":"#/definitions/UserReference"},"lastRunDate":{"type":"string","format":"date-time","description":"The date the activity plan was last run, in ISO-8601 format"},"lastRunBy":{"description":"The last user to run this activity plan","$ref":"#/definitions/UserReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"ActivityPlanServiceGoalImpactOverrides":{"type":"object","required":["abandonRate","averageSpeedOfAnswer","serviceLevel"],"properties":{"abandonRate":{"description":"Abandon rate service goal override for the associated activity plan","$ref":"#/definitions/ActivityPlanAbandonRateImpactOverride"},"serviceLevel":{"description":"Service level goal override for the associated activity plan","$ref":"#/definitions/ActivityPlanServiceLevelImpactOverride"},"averageSpeedOfAnswer":{"description":"Average speed of answer service goal override for the associated activity plan","$ref":"#/definitions/ActivityPlanAsaImpactOverride"}}},"ActivityPlanServiceLevelImpactOverride":{"type":"object","required":["decreaseByPercent"],"properties":{"decreaseByPercent":{"type":"number","format":"double","description":"Allowed service level decrease percent, from 0.0 to 100.0"}}},"AvailabilityRange":{"type":"object","required":["earliestStartMinutesFromMidnight","latestEndMinutesFromMidnight"],"properties":{"earliestStartMinutesFromMidnight":{"type":"integer","format":"int32","description":"The earliest time of day the activity can be scheduled to begin, in minutes from midnight in the configured time zone of the business unit"},"latestEndMinutesFromMidnight":{"type":"integer","format":"int32","description":"The latest time of day the activity can be scheduled to end, in minutes from midnight in the configured time zone of the business unit"}}},"FixedAvailability":{"type":"object","properties":{"availabilityRange":{"description":"The range of time of day the activity can be scheduled","$ref":"#/definitions/AvailabilityRange"},"dateRange":{"description":"The range of date for which the activity plan could be scheduled","$ref":"#/definitions/RequiredLocalDateRange"},"daysOfWeek":{"type":"array","description":"The days of week available for scheduling. Empty list or null means daysOfWeek is not considered","items":{"type":"string","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]}}}},"GroupSettings":{"type":"object","properties":{"minimumGroupSize":{"type":"integer","format":"int32","description":"The minimum size of a group for a session"},"maximumGroupSize":{"type":"integer","format":"int32","description":"The maximum size of a group for a session"},"maximumTotalSessions":{"type":"integer","format":"int32","description":"The maximum total number of sessions"},"maximumConcurrentSessions":{"type":"integer","format":"int32","description":"The maximum number of sessions that can be scheduled concurrently"}}},"RequiredLocalDateRange":{"type":"object","required":["endDate","startDate"],"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"}}},"SchedulingPeriod":{"type":"object","required":["earliestStartDate","latestEndDate"],"properties":{"earliestStartDate":{"type":"string","format":"date","description":"The earliest date the associated activity plan can begin, in YYYY-MM-DD format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"latestEndDate":{"type":"string","format":"date","description":"The latest date the associated activity plan can end, in YYYY-MM-DD format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"UserSearchRule":{"type":"object","required":["parts"],"properties":{"parts":{"type":"array","description":"The parts of this rule; the results of these are ANDed together.","items":{"$ref":"#/definitions/UserSearchRulePart"}}}},"UserSearchRulePart":{"type":"object","required":["ids","operation","selector"],"properties":{"operation":{"type":"string","description":"The operation for this part","enum":["Include","Exclude"]},"selector":{"type":"string","description":"The type of item being selected by this part","enum":["AcdSkill","User","Group","Queue","Division","ManagementUnit"]},"ids":{"type":"array","description":"The ids for the selector; the results of these are ORed together","uniqueItems":true,"items":{"type":"string"}}}},"CreateActivityPlanRequest":{"type":"object","required":["activityCodeId","countsAsPaidTime","initialSchedulePeriod","lengthMinutes","name","optimizationObjective","state","transitionTimeMinutes","type"],"properties":{"name":{"type":"string","description":"The name of the activity plan"},"managementUnitIds":{"type":"array","description":"The management units to which this activity plan applies. Empty list or null means this activity plan applies to the entire business unit","items":{"type":"string"}},"description":{"type":"string","description":"The description of the activity plan"},"activityCodeId":{"type":"string","description":"The activity code associated with the activity plan"},"type":{"type":"string","description":"The type of the activity plan","enum":["Individual","Group"]},"lengthMinutes":{"type":"integer","format":"int32","description":"The length in minutes of the activity plan"},"initialSchedulePeriod":{"description":"The initial scheduling period for the activity plan","$ref":"#/definitions/SchedulingPeriod"},"groupSettings":{"description":"Group settings for the activity plan","$ref":"#/definitions/GroupSettings"},"recurrenceSettings":{"description":"Settings controlling recurrence for the activity plan. If not set the activity plan will only occur once","$ref":"#/definitions/RecurrenceSettings"},"attendeesSearchRule":{"description":"Attendee search rule for this activity plan","$ref":"#/definitions/UserSearchRule"},"facilitated":{"type":"boolean","description":"Whether the sessions created by this activity plan should be facilitated"},"facilitatorsSearchRule":{"description":"Facilitator search rule for this activity plan","$ref":"#/definitions/UserSearchRule"},"transitionTimeMinutes":{"type":"integer","format":"int32","description":"Transition time in minutes between facilitated sessions"},"serviceGoalImpactOverrides":{"description":"Allowable service goal impact override settings for this activity plan. If not set the business unit setting will be used","$ref":"#/definitions/ActivityPlanServiceGoalImpactOverrides"},"optimizationObjective":{"type":"string","description":"The optimization objective of this activity plan","enum":["FavorServiceGoals","FavorSchedulingAll"]},"state":{"type":"string","description":"The state of this activity plan","enum":["Active","Inactive"]},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity should count as paid time"},"fixedAvailability":{"type":"array","description":"Fixed availability configuration for the activity plan","items":{"$ref":"#/definitions/FixedAvailability"}}}},"ListWrapperFixedAvailability":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/FixedAvailability"}}}},"UpdateActivityPlanRequest":{"type":"object","properties":{"name":{"type":"string","description":"The name of the activity plan"},"description":{"type":"string","description":"The description of the activity plan"},"groupSettings":{"description":"Group settings for the activity plan","$ref":"#/definitions/ValueWrapperGroupSettings"},"attendeesSearchRule":{"description":"Attendee search rule for this activity plan","$ref":"#/definitions/ValueWrapperUserSearchRule"},"facilitatorsSearchRule":{"description":"Facilitator search rule for this activity plan","$ref":"#/definitions/ValueWrapperUserSearchRule"},"transitionTimeMinutes":{"type":"integer","format":"int32","description":"Transition time in minutes between facilitated sessions"},"serviceGoalImpactOverrides":{"description":"Allowable service goal impact override settings for this activity plan","$ref":"#/definitions/ValueWrapperActivityPlanServiceGoalImpactOverrides"},"optimizationObjective":{"type":"string","description":"The optimization objective of this activity plan","enum":["FavorServiceGoals","FavorSchedulingAll"]},"state":{"type":"string","description":"The state of this activity plan","enum":["Active","Inactive"]},"fixedAvailability":{"description":"Fixed availability configuration for the activity plan","$ref":"#/definitions/ListWrapperFixedAvailability"}}},"ValueWrapperActivityPlanServiceGoalImpactOverrides":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/ActivityPlanServiceGoalImpactOverrides"}}},"ValueWrapperGroupSettings":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/GroupSettings"}}},"ValueWrapperUserSearchRule":{"type":"object","properties":{"value":{"description":"The value for the associated field","$ref":"#/definitions/UserSearchRule"}}},"ActivityPlanRunJobResponse":{"type":"object","required":["activityPlan","exceptions","status"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"activityPlan":{"description":"The activity plan associated with this job","$ref":"#/definitions/ActivityPlanReference"},"status":{"type":"string","description":"The status of the job","enum":["Processing","Complete","Error"]},"exceptions":{"type":"array","description":"The list of exceptions that occurred while running this activity plan job. These are exceptions that affect individual occurrences but didn't prevent the job from completing","items":{"$ref":"#/definitions/ActivityPlanJobException"}},"error":{"description":"Error details if status == 'Error'. These are errors that caused the job to fail to complete","$ref":"#/definitions/ErrorBody"},"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}}},"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}}},"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"}}},"AdherenceExplanationAsyncResponse":{"type":"object","properties":{"job":{"description":"A reference to the job that was started by the request","$ref":"#/definitions/AdherenceExplanationJobReference"}}},"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"]}}},"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"}}},"ActivityCodeSummary":{"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}}},"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}}},"UserNextActivityReminder":{"type":"object","properties":{}},"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/ActivityCodeSummary"},"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"}}},"AlternativeShiftBuSettingsResponse":{"type":"object","required":["enabledGranularities","metadata","minMinutesBeforeStartTime","retainedActivityCategories"],"properties":{"enabledGranularities":{"type":"array","description":"The granularity at which alternative shifts is allowed. An empty list means Alternative Shifts is disabled","items":{"type":"string","enum":["Daily"]}},"minMinutesBeforeStartTime":{"type":"integer","format":"int32","description":"The minimum number of minutes before the start of a shift that an alternative shift can be automatically approved"},"retainedActivityCategories":{"type":"array","description":"Categories of activities that are required to remain at the same time slot for the alternative shifts offered. An empty list represents no retained activities","items":{"type":"string","enum":["Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable"]}},"metadata":{"description":"Version metadata for this business unit's alternative shift settings","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AlternativeShiftAgentScheduledShift":{"type":"object","required":["activities","dayIndex","lengthMinutes","referenceKey","startDate"],"properties":{"dayIndex":{"type":"integer","format":"int32","description":"The number of days since start of schedule"},"referenceKey":{"type":"string","description":"A key generated for an offer to help facilitate alternative shift trading"},"startDate":{"type":"string","format":"date-time","description":"The start date of this shift in ISO-8601 format"},"lengthMinutes":{"type":"integer","format":"int32","description":"The length of this shift in minutes"},"activities":{"type":"array","description":"A list of activities in this shift","items":{"$ref":"#/definitions/BuAgentScheduleActivity"}}}},"AlternativeShiftBulkUpdateTradesResponseTemplate":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AlternativeShiftTradeBulkUpdateTemplateItem"}}}},"AlternativeShiftOffersViewResponseTemplate":{"type":"object","required":["agentId","alternativeDays","businessUnitId","jobId","managementUnitId","offerWeekDate","schedule","shifts"],"properties":{"jobId":{"type":"string","description":"The unique identifier of the async list job that created this file"},"businessUnitId":{"type":"string","description":"The unique identifier of the business unit to which the user (agent) belongs at the time the offer is created"},"agentId":{"type":"string","description":"The unique identifier of the agent for whom the offer was made"},"managementUnitId":{"type":"string","description":"The unique identifier of the management unit to which the user (agent) belongs at the time the offer is created"},"schedule":{"description":"The existing schedule information associated with the offer","$ref":"#/definitions/AlternativeShiftScheduleLookup"},"offerWeekDate":{"type":"string","format":"date","description":"The first date of the week for the schedule we are querying in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"shifts":{"type":"array","description":"The shifts the agent is scheduled for at the time the offer is created","items":{"$ref":"#/definitions/AlternativeShiftAgentScheduledShift"}},"alternativeDays":{"type":"array","description":"The offered alternative shift days in this week at the time the offer is created","items":{"$ref":"#/definitions/AlternativeShiftAgentScheduledShift"}}}},"AlternativeShiftScheduleLookup":{"type":"object","required":["id","weekDate"],"properties":{"id":{"type":"string","description":"The unique identifier of the schedule"},"weekDate":{"type":"string","format":"date","description":"The start date for this schedule in yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"AlternativeShiftTradeBulkUpdateTemplateItem":{"type":"object","required":["metadata","state","tradeId"],"properties":{"tradeId":{"type":"string","description":"The ID of this alternative shift trade"},"state":{"type":"string","description":"The current state of this alternative shift trade request","enum":["Canceled","Denied","Expired","Submitted","Approved"]},"failureReason":{"type":"string","description":"The reason the update failed, if applicable","enum":["TransitionNotAllowed","NotAuthorized"]},"adminDateReviewed":{"type":"string","format":"date-time","description":"The timestamp of when the trade request was manually reviewed by an admin in ISO-8601 format"},"adminReviewedBy":{"description":"The admin who manually reviewed this alternative shift trade after system denial","$ref":"#/definitions/UserReference"},"metadata":{"description":"Version metadata for this alternative shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AlternativeShiftTradeListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}}}},"AlternativeShiftTradeResponse":{"type":"object","required":["existingShifts","managementUnit","metadata","offeredShifts","schedule","shiftOfferJobId","state","user","violations"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"shiftOfferJobId":{"type":"string","description":"The job ID of the alternative shift offer listing, from which the trade was chosen"},"existingShifts":{"type":"array","description":"The existing shifts from the offer, may be empty","items":{"$ref":"#/definitions/AlternativeShiftAgentScheduledShift"}},"offeredShifts":{"type":"array","description":"The offered shifts from the offer, may be empty","items":{"$ref":"#/definitions/AlternativeShiftAgentScheduledShift"}},"schedule":{"description":"The existing schedule information associated with the trade","$ref":"#/definitions/AlternativeShiftScheduleLookup"},"managementUnit":{"description":"The management unit of this alternative shift trade request","$ref":"#/definitions/ManagementUnitReference"},"user":{"description":"The user who submitted the trade request","$ref":"#/definitions/UserReference"},"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"},"expirationDate":{"type":"string","format":"date-time","description":"The date when the trade will expire in ISO-8601 format. The trade cannot be approved after expiration"},"state":{"type":"string","description":"The state of this alternative shift trade","enum":["Canceled","Denied","Expired","Submitted","Approved"]},"processingStatus":{"type":"string","description":"The processing status of this alternative shift trade","enum":["Error","WaitingForScheduleUpdate","ScheduleUpdating","ScheduleUpdated","WaitingForReview","Reviewing"]},"systemDateReviewed":{"type":"string","format":"date-time","description":"The timestamp of when the trade request was reviewed by the system in ISO-8601 format"},"adminDateReviewed":{"type":"string","format":"date-time","description":"The timestamp of when the trade request was reviewed by an admin in ISO-8601 format"},"adminReviewedBy":{"description":"The admin who reviewed this alternative shift trade after system denial","$ref":"#/definitions/UserReference"},"violations":{"type":"array","description":"A list of trade match violations","items":{"type":"string","enum":["ServiceGoalsNotMet"]}},"metadata":{"description":"Version metadata for this alternative shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlternativeShiftTradesViewResponseTemplate":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AlternativeShiftTradeResponse"}}}},"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"]}}},"BuAlternativeShiftJobResponse":{"type":"object","required":["status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the alternative shift job","enum":["Processing","Complete","Error"]},"type":{"type":"string","description":"The type of job","enum":["ListOffers","SearchOffers","ListUserTrades","SearchTrades","BulkUpdateTrades"]},"downloadUrl":{"type":"string","description":"The URL where completed results are available, only set if status == 'Complete'"},"error":{"description":"Any error information, only set if the status == 'Error'","$ref":"#/definitions/ErrorBody"},"viewOffersResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListOffers' or 'SearchOffers'","$ref":"#/definitions/AlternativeShiftOffersViewResponseTemplate"},"viewTradesResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListUserTrades' or 'SearchTrades'","$ref":"#/definitions/AlternativeShiftTradesViewResponseTemplate"},"bulkUpdateTradesResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'BulkUpdateTrades'","$ref":"#/definitions/AlternativeShiftBulkUpdateTradesResponseTemplate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"BuListAlternativeShiftTradesResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the request. Null if result returns synchronously","$ref":"#/definitions/BuAlternativeShiftJobResponse"},"result":{"description":"The result of the request. May come via notification. Null if job is populated","$ref":"#/definitions/AlternativeShiftTradeListing"}}},"SearchAlternativeShiftTradesRequest":{"type":"object","properties":{"managementUnitIds":{"type":"array","description":"The list of management unit IDs for this alternative shift trade search. Either managementUnitIds or agentIds is required","items":{"type":"string"}},"agentIds":{"type":"array","description":"The list of agent IDs for this alternative shift trade search. Either managementUnitIds or agentIds is required","items":{"type":"string"}}}},"ListWrapperAlternativeShiftBuSettingsActivityCategory":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string","enum":["Break","Meal","Meeting","OffQueueWork","TimeOff","Training","Unavailable"]}}}},"ListWrapperAlternativeShiftBuSettingsGranularity":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string","enum":["Daily"]}}}},"UpdateAlternativeShiftBuSettingsRequest":{"type":"object","required":["metadata"],"properties":{"enabledGranularities":{"description":"The granularity at which alternative shifts is allowed. An empty list as the wrapped value will indicate alternative shifts is disabled","$ref":"#/definitions/ListWrapperAlternativeShiftBuSettingsGranularity"},"minMinutesBeforeStartTime":{"type":"integer","format":"int32","description":"The minimum number of minutes before the start of a shift that an alternative shift can be automatically approved"},"retainedActivityCategories":{"description":"Categories of activities that are required to remain at the same time slot for the alternative shifts offered. An empty list indicates no retained activities","$ref":"#/definitions/ListWrapperAlternativeShiftBuSettingsActivityCategory"},"metadata":{"description":"Version metadata for this business unit's alternative shift settings","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AlternativeShiftJobResponse":{"type":"object","required":["status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the alternative shift job","enum":["Processing","Complete","Error"]},"type":{"type":"string","description":"The type of job","enum":["ListOffers","SearchOffers","ListUserTrades","SearchTrades","BulkUpdateTrades"]},"downloadUrl":{"type":"string","description":"The URL where completed results are available, only set if status == 'Complete'"},"error":{"description":"Any error information, only set if the status == 'Error'","$ref":"#/definitions/ErrorBody"},"viewOffersResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListOffers' or 'SearchOffers'","$ref":"#/definitions/AlternativeShiftOffersViewResponseTemplate"},"viewTradesResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'ListUserTrades' or 'SearchTrades'","$ref":"#/definitions/AlternativeShiftTradesViewResponseTemplate"},"bulkUpdateTradesResults":{"description":"Schema template for deserializing data returned from the downloadUrl. Use if type == 'BulkUpdateTrades'","$ref":"#/definitions/AlternativeShiftBulkUpdateTradesResponseTemplate"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlternativeShiftAsyncResponse":{"type":"object","required":["job"],"properties":{"job":{"description":"The job related to the async request","$ref":"#/definitions/AlternativeShiftJobReference"}}},"AlternativeShiftJobReference":{"type":"object","required":["status","type"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"status":{"type":"string","description":"The status of the alternative shift job","enum":["Processing","Complete","Error"]},"type":{"type":"string","description":"The type of alternative shift asynchronous job","enum":["ListOffers","SearchOffers","ListUserTrades","SearchTrades","BulkUpdateTrades"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AlternativeShiftSearchOffersRequest":{"type":"object","required":["initiatingShift","queryWeekDate","schedule"],"properties":{"schedule":{"description":"The existing schedule being used to find alternative shift offers","$ref":"#/definitions/AlternativeShiftScheduleLookup"},"queryWeekDate":{"type":"string","format":"date","description":"The start date for the week in this schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"initiatingShift":{"description":"The shift a user puts up for alternative shift offers","$ref":"#/definitions/InitiatingAlternativeShift"},"acceptableIntervals":{"type":"array","description":"The acceptable intervals in offers. 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"}}}},"InitiatingAlternativeShift":{"type":"object","required":["id","startDate"],"properties":{"id":{"type":"string","description":"The ID of the shift from a user's schedule"},"startDate":{"type":"string","format":"date-time","description":"The start date for the shift in the user's schedule in ISO-8601 format. For example: YYYY-MM-DDThh:mm:ss.SSSZ"}}},"AlternativeShiftOffersRequest":{"type":"object","required":["queryWeekDate","schedule"],"properties":{"schedule":{"description":"The existing schedule being used to find alternative shift offers","$ref":"#/definitions/AlternativeShiftScheduleLookup"},"queryWeekDate":{"type":"string","format":"date","description":"The start date for the week in this schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"}}},"CreateAlternativeShiftTradeRequest":{"type":"object","required":["alternativeShiftTradeGranularity","jobId"],"properties":{"jobId":{"type":"string","description":"The ID of this alternative shift job"},"dropShiftReferenceKeys":{"type":"array","description":"A list of offered shift reference keys an agent wants to drop","items":{"type":"string"}},"pickupShiftReferenceKeys":{"type":"array","description":"A list of offered shift reference keys an agent wants to pick up","items":{"type":"string"}},"alternativeShiftTradeGranularity":{"type":"string","description":"The granularity of alternative shifts to be traded","enum":["Daily"]},"expirationDate":{"type":"string","format":"date-time","description":"The date when the trade will expire in ISO-8601 format. The trade cannot be approved after expiration"}}},"ListAlternativeShiftTradesResponse":{"type":"object","properties":{"job":{"description":"The asynchronous job handling the request. Null if result returns synchronously","$ref":"#/definitions/AlternativeShiftJobResponse"},"result":{"description":"The result of the request. May come via notification. Null if job is populated","$ref":"#/definitions/AlternativeShiftTradeListing"}}},"AgentUpdateAlternativeShiftTradeRequest":{"type":"object","required":["metadata"],"properties":{"state":{"type":"string","description":"The new state of this alternative shift trade","enum":["Canceled"]},"metadata":{"description":"Version metadata for this alternative shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AdminBulkUpdateAlternativeShiftTradeState":{"type":"object","required":["metadata","state","tradeId"],"properties":{"tradeId":{"type":"string","description":"The ID of the trade for this alternative shift trade"},"state":{"type":"string","description":"The new alternative shift trade state","enum":["Approved","Denied"]},"metadata":{"description":"Version metadata for this alternative shift trade","$ref":"#/definitions/WfmVersionedEntityMetadata"}}},"AdminBulkUpdateAlternativeShiftTradeStateRequest":{"type":"object","required":["managementUnitId"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AdminBulkUpdateAlternativeShiftTradeState"}},"managementUnitId":{"type":"string","description":"The ID of the management unit for this alternative shift bulk trade update"}}},"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"}}},"AgentWorkPlanBid":{"type":"object","required":["bidWindowEndDate","bidWindowStartDate","effectiveDate","id","status","workPlanFieldsVisibleToAgents"],"properties":{"id":{"type":"string","description":"The ID of the work plan bid"},"name":{"type":"string"},"bidWindowStartDate":{"type":"string","format":"date","description":"The date when agents can start participating in work plan bidding. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"bidWindowEndDate":{"type":"string","format":"date","description":"The inclusive end date of a bid window. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"effectiveDate":{"type":"string","format":"date","description":"The date when agents will be assigned to the new work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"status":{"type":"string","description":"The state of the bid","enum":["Draft","Locked","Optimized","Scheduled","Open","Closed","Processed","Published"]},"workPlanFieldsVisibleToAgents":{"type":"array","description":"The work plan fields visible to agents whenever work plan preferences are made","items":{"type":"string","enum":["Name","PaidHours"]}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan bid reference"},"AgentWorkPlanBids":{"type":"object","required":["agentWorkPlanBids"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"businessUnit":{"description":"The business unit to which the bids belong","$ref":"#/definitions/BusinessUnitReference"},"agentWorkPlanBids":{"type":"array","description":"Work plan bid summaries associated with this agent","items":{"$ref":"#/definitions/AgentWorkPlanBid"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentWorkPlanBiddingPreference":{"type":"object","required":["workPlan"],"properties":{"workPlan":{"description":"The work plan that belongs to the agent's bid group","$ref":"#/definitions/WorkPlanReference"},"priority":{"type":"integer","format":"int32","description":"The agent's priority for this work plan, with 1 being the best priority. Null if priority is not set for the work plan"}}},"AgentWorkPlanBiddingPreferenceResponse":{"type":"object","required":["agentWorkPlanBidPreferences","submitted"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"submitted":{"type":"boolean","description":"Whether the preference is submitted"},"assignedWorkPlan":{"description":"The work plan assigned to the agent by the bid process","$ref":"#/definitions/WorkPlanReference"},"overriddenWorkPlan":{"description":"The work plan that overrides the assigned work plan for the agent","$ref":"#/definitions/WorkPlanReference"},"overrideReason":{"type":"string","description":"The reason why the assigned work plan has been overridden. This must be null without an override work plan","enum":["UnableToBid","ChangeOfCircumstance","NewHire","EmployeeMove"]},"agentWorkPlanBidPreferences":{"type":"array","description":"The list of work plan bidding preferences","items":{"$ref":"#/definitions/AgentWorkPlanBiddingPreference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentWorkPlanBiddingPreferenceRequest":{"type":"object","required":["workPlanId"],"properties":{"workPlanId":{"type":"string","description":"The ID of the work plan that belongs to agent's bid group"},"priority":{"type":"integer","format":"int32","description":"The agent's priority for this work plan, with 1 being the best priority. Null if priority is not set for the work plan"}}},"UpdateAgentWorkPlanBiddingPreference":{"type":"object","required":["agentWorkPlanBidPreferences","submitted"],"properties":{"submitted":{"type":"boolean","description":"Whether the preference is submitted"},"agentWorkPlanBidPreferences":{"type":"array","description":"The list of work plan bidding preferences","items":{"$ref":"#/definitions/AgentWorkPlanBiddingPreferenceRequest"}}}},"AgentWorkPlan":{"type":"object","required":["constrainWeeklyPaidTime","flexibleWeeklyPaidTime","shifts","weeklyExactPaidMinutes","weeklyMaximumPaidMinutes","weeklyMinimumPaidMinutes"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"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"},"optionalDays":{"description":"Optional days to schedule for this work plan","$ref":"#/definitions/SetWrapperDayOfWeek"},"shifts":{"type":"array","description":"Shifts in this work plan","items":{"$ref":"#/definitions/AgentWorkPlanShift"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentWorkPlanActivity":{"type":"object","required":["countsAsPaidTime","lengthMinutes"],"properties":{"lengthMinutes":{"type":"integer","format":"int32","description":"Length of the activity in minutes"},"countsAsPaidTime":{"type":"boolean","description":"Whether the activity is paid"}}},"AgentWorkPlanListResponse":{"type":"object","required":["managementUnit"],"properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/AgentWorkPlan"}},"managementUnit":{"description":"The management unit of the work plans","$ref":"#/definitions/ManagementUnitReference"}}},"AgentWorkPlanShift":{"type":"object","required":["activities","constrainLatestStopTime","days","earliestStartTimeMinutesFromMidnight","earliestStopTimeMinutesFromMidnight","exactPaidTimeMinutes","exactStartTimeMinutesFromMidnight","flexiblePaidTime","flexibleStartTime","latestStartTimeMinutesFromMidnight","latestStopTimeMinutesFromMidnight","maximumPaidTimeMinutes","minimumPaidTimeMinutes"],"properties":{"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"},"earliestStopTimeMinutesFromMidnight":{"type":"integer","format":"int32","description":"This is the earliest time a shift can end"},"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"},"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"},"activities":{"type":"array","description":"Activities configured for this shift","items":{"$ref":"#/definitions/AgentWorkPlanActivity"}}}},"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 week date of the initiating shift of the shift trade in yyyy-MM-dd format"},"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"}}}},"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"}}}},"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"}}}},"ActivityCodesReference":{"type":"object","properties":{"ids":{"type":"array","description":"The IDs of activity codes","uniqueItems":true,"items":{"type":"string"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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","CheckActivityCodes","CheckLimitsAndActivityCodes"]},"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"}}},"WorkPlanBidGroupSummary":{"type":"object","required":["agentCount","managementUnit","name","planningGroupCount","workPlanCount"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string","description":"The name assigned to this bid group"},"managementUnit":{"description":"The management unit this bid group belongs to","$ref":"#/definitions/ManagementUnitReference"},"agentCount":{"type":"integer","format":"int32","description":"The number of agents in this bid group"},"workPlanCount":{"type":"integer","format":"int32","description":"The number of work plans in this bid group"},"planningGroupCount":{"type":"integer","format":"int32","description":"The number of planning groups in this bid group"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanBidGroupSummaryList":{"type":"object","required":["workPlanBidGroupSummaryList"],"properties":{"workPlanBidGroupSummaryList":{"type":"array","description":"List of work plan bid group summary","items":{"$ref":"#/definitions/WorkPlanBidGroupSummary"}}}},"AgentCountRange":{"type":"object","required":["maximum","minimum"],"properties":{"minimum":{"type":"integer","format":"int32","description":"The minimum value of agent count per work plan"},"maximum":{"type":"integer","format":"int32","description":"The maximum value of agent count per work plan"}}},"BidGroupWorkPlanResponse":{"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"},"overrideAgentCount":{"type":"integer","format":"int32","description":"The modified agent count for this work plan"},"suggestedAgentCount":{"type":"integer","format":"int32","description":"The number of agents needed for this work plan to produce the optimal schedule","readOnly":true},"agentCountRange":{"description":"The range of agent slot count per work plan. The suggested slot count must be in agent count range","readOnly":true,"$ref":"#/definitions/AgentCountRange"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanBidGroup":{"type":"object","required":["agents","managementUnit","name","planningGroups","workPlans"],"properties":{"name":{"type":"string","description":"The name of the work plan bid group"},"managementUnit":{"description":"The management unit this bid group belongs to","$ref":"#/definitions/ManagementUnitReference"},"agents":{"type":"array","description":"The list of agents who participate in this bid group","items":{"$ref":"#/definitions/UserReference"}},"workPlans":{"type":"array","description":"The list of work plans used in this bid group","items":{"$ref":"#/definitions/BidGroupWorkPlanResponse"}},"planningGroups":{"type":"array","description":"The list of planning groups selected in this bid group","items":{"$ref":"#/definitions/PlanningGroupReference"}}}},"WorkPlanBidGroupResponse":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"workPlanBidGroup":{"description":"The work plan bid group","$ref":"#/definitions/WorkPlanBidGroup"},"metadata":{"description":"The meta data of the bid group","$ref":"#/definitions/WorkPlanBidMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanBidMetadata":{"type":"object","required":["createdBy","createdDate"],"properties":{"createdBy":{"description":"The user who created the associated entity","$ref":"#/definitions/UserReference"},"createdDate":{"type":"string","format":"date-time","description":"The date the entity created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"modifiedBy":{"description":"The user who modified the entity","$ref":"#/definitions/UserReference"},"modifiedDate":{"type":"string","format":"date-time","description":"The entity last modified date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"BidGroupWorkPlanRequest":{"type":"object","required":["workPlanId"],"properties":{"workPlanId":{"type":"string","description":"The ID of the work plan used in the bid group"},"overrideAgentCount":{"type":"integer","format":"int32","description":"The modified agent count for this work plan"},"suggestedAgentCount":{"type":"integer","format":"int32","description":"The number of agents needed for this work plan to produce the optimal schedule","readOnly":true},"agentCountRange":{"description":"The range of agent slot count per work plan. The suggested slot count must be in agent count range","readOnly":true,"$ref":"#/definitions/AgentCountRange"}}},"WorkPlanBidGroupCreate":{"type":"object","required":["agentIds","managementUnitId","name","planningGroupIds","workPlans"],"properties":{"name":{"type":"string","description":"The name of the work plan bid group"},"managementUnitId":{"type":"string","description":"The management unit ID this bid group belongs to"},"agentIds":{"type":"array","description":"Agent IDs who participate in this bid group","items":{"type":"string"}},"workPlans":{"type":"array","description":"The list of work plans used in this bid group","items":{"$ref":"#/definitions/BidGroupWorkPlanRequest"}},"planningGroupIds":{"type":"array","description":"The planning group IDs selected in this bid group","items":{"type":"string"}}}},"ListWrapperBidGroupWorkPlanRequest":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/definitions/BidGroupWorkPlanRequest"}}}},"WorkPlanBidGroupUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the work plan bid group"},"managementUnitId":{"type":"string","description":"The management unit ID used for this work plan bid group"},"agentIds":{"description":"Agent IDs who participate in this bid group","$ref":"#/definitions/ListWrapperString"},"workPlans":{"description":"The list of work plans used in this bid group","$ref":"#/definitions/ListWrapperBidGroupWorkPlanRequest"},"planningGroupIds":{"description":"The planning group IDs selected in this bid group","$ref":"#/definitions/ListWrapperString"}}},"AdminAgentWorkPlanBiddingPreference":{"type":"object","required":["agent","submitted"],"properties":{"agent":{"description":"The agent to whom this work plan bidding preference applies","$ref":"#/definitions/UserReference"},"submitted":{"type":"boolean","description":"Whether the preference is submitted"},"assignedWorkPlan":{"description":"The work plan assigned to the agent by the bid process","$ref":"#/definitions/WorkPlanReference"},"overriddenWorkPlan":{"description":"The work plan that overrides the assigned work plan for the agent","$ref":"#/definitions/WorkPlanReference"},"overrideReason":{"type":"string","description":"The reason why the assigned work plan has been overridden. This must be null without an override work plan","enum":["UnableToBid","ChangeOfCircumstance","NewHire","EmployeeMove"]},"priorities":{"type":"array","description":"The agent priorities for the list of work plans. The index of the priorities should match with the list of work plans that belong to bid group. It contains null if priority is not set for the work plan","items":{"type":"integer","format":"int32"}}}},"AdminAgentWorkPlanPreferenceResponse":{"type":"object","required":["agentWorkPlanBidPreferences","workPlans"],"properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"workPlans":{"type":"array","description":"The list of work plans that belong to this bid group","items":{"$ref":"#/definitions/WorkPlanReference"}},"agentWorkPlanBidPreferences":{"type":"array","description":"The list of agents work plan bidding preferences","items":{"$ref":"#/definitions/AdminAgentWorkPlanBiddingPreference"}},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"AgentBidWorkPlanOverrideRequest":{"type":"object","required":["agentId"],"properties":{"agentId":{"type":"string","description":"The ID of agent"},"overrideWorkPlanId":{"type":"string","description":"The ID of the work plan that overrides the assigned work plan for the agent"},"overrideReason":{"type":"string","description":"The reason for overriding the assigned work plan. This must be null if overrideWorkPlanId is not specified","enum":["UnableToBid","ChangeOfCircumstance","NewHire","EmployeeMove"]}}},"AgentsBidAssignedWorkPlanOverrideRequest":{"type":"object","required":["agentWorkPlanOverrides"],"properties":{"agentWorkPlanOverrides":{"type":"array","description":"The list of agent work plan overrides","items":{"$ref":"#/definitions/AgentBidWorkPlanOverrideRequest"}}}},"BuShortTermForecastWeekReference":{"type":"object","required":["id","weekDate","weekNumber"],"properties":{"id":{"type":"string","description":"Forecast id used in this work plan bid"},"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},"weekNumber":{"type":"integer","format":"int32","description":"The week number used for this bid. First week starts with number 1"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkPlanBid":{"type":"object","required":["agentRankingType","bidWindowEndDate","bidWindowStartDate","effectiveDate","id","name","rankingTiebreakerType","status","workPlanFieldsVisibleToAgents"],"properties":{"id":{"type":"string","description":"The ID of the work plan bid"},"name":{"type":"string","description":"The name of the work plan bid"},"forecast":{"description":"The selected forecast in this work plan bid","$ref":"#/definitions/BuShortTermForecastWeekReference"},"bidWindowStartDate":{"type":"string","format":"date","description":"The bid start date where agents start participate in work plan bidding. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"bidWindowEndDate":{"type":"string","format":"date","description":"The bid end date. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"effectiveDate":{"type":"string","format":"date","description":"The date when agents will be assigned to the new work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"status":{"type":"string","description":"The state of the bid","enum":["Draft","Locked","Optimized","Scheduled","Open","Closed","Processed","Published"]},"agentRankingType":{"type":"string","description":"The type of agent ranking selected for this bid","enum":["HireDate","Performance"]},"rankingTiebreakerType":{"type":"string","description":"Ranking tiebreaker","enum":["HireDate","Performance","Custom","RandomlyAssign"]},"publishedDate":{"type":"string","format":"date-time","description":"The date the work plan bid published. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"workPlanFieldsVisibleToAgents":{"type":"array","description":"The work plan fields visible to agents whenever work plan preferences are made","items":{"type":"string","enum":["Name","PaidHours"]}},"metadata":{"description":"The meta data of this bid","$ref":"#/definitions/WorkPlanBidMetadata"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}},"description":"Work plan bid response"},"CreateWorkPlanBid":{"type":"object","required":["agentRankingType","bidWindowEndDate","bidWindowStartDate","effectiveDate","name","rankingTiebreakerType","workPlanFieldsVisibleToAgents"],"properties":{"name":{"type":"string","description":"The name of the work plan bid"},"forecast":{"description":"The selected forecast in this work plan bid","$ref":"#/definitions/BuShortTermForecastWeekReference"},"bidWindowStartDate":{"type":"string","format":"date","description":"The bid start date where agents start participate in work plan bidding in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"bidWindowEndDate":{"type":"string","format":"date","description":"The bid end date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"effectiveDate":{"type":"string","format":"date","description":"The date when agents will be assigned to the new work plan in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"agentRankingType":{"type":"string","description":"The type of agent ranking selected for this bid","enum":["HireDate","Performance"]},"rankingTiebreakerType":{"type":"string","description":"Ranking tiebreaker to be used","enum":["HireDate","Performance","Custom","RandomlyAssign"]},"workPlanFieldsVisibleToAgents":{"type":"array","description":"The work plan fields visible to agents whenever work plan preferences are made","items":{"type":"string","enum":["Name","PaidHours"]}}},"description":"Create work plan bid model"},"WorkPlanBidListResponse":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkPlanBid"}}}},"ListWrapperAgentWorkPlanField":{"type":"object","properties":{"values":{"type":"array","items":{"type":"string","enum":["Name","PaidHours"]}}}},"UpdateWorkPlanBid":{"type":"object","properties":{"name":{"type":"string","description":"The name of the work plan bid"},"forecast":{"description":"The selected forecast in this work plan bid","$ref":"#/definitions/BuShortTermForecastWeekReference"},"bidWindowStartDate":{"type":"string","format":"date","description":"The bid start date where agents start participate in work plan bidding in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"bidWindowEndDate":{"type":"string","format":"date","description":"The bid end date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"effectiveDate":{"type":"string","format":"date","description":"The date when agents will be assigned to the new work plan in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd"},"agentRankingType":{"type":"string","description":"The type of agent ranking selected for this bid","enum":["HireDate","Performance"]},"rankingTiebreakerType":{"type":"string","description":"Ranking tiebreaker","enum":["HireDate","Performance","Custom","RandomlyAssign"]},"workPlanFieldsVisibleToAgents":{"description":"The work plan fields visible to agents whenever work plan preferences are made","$ref":"#/definitions/ListWrapperAgentWorkPlanField"},"status":{"type":"string","description":"The state of the bid","enum":["Draft","Locked","Optimized","Scheduled","Open","Closed","Processed","Published"]}},"description":"Update work plan bid model"},"CopyWorkPlanBid":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the new work plan bid"}}},"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}}},"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 512 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 512 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."}}},"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"}}},"WorkitemScriptReference":{"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}}},"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}}},"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 512 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."},"languageId":{"type":"string","description":"The ID of language 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"}},"wrapupCode":{"type":"string","description":"The ID of the wrapup. Must be a valid UUID."},"utilizationLabelId":{"type":"string","description":"The ID of utilization label of the Workitem. 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"}},"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"}},"queryFilters":{"type":"array","description":"Query filters for nested attributes.","items":{"$ref":"#/definitions/WorkitemQueryJobQueryFilters"},"maxItems":1,"minItems":1},"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"},"dateIntervalStart":{"type":"string","format":"date-time","description":"Interval start date to use to filter results based on create date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateIntervalEnd":{"type":"string","format":"date-time","description":"Interval end date to use to filter results based on create date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"}}},"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"}}}},"WorkitemQueryJobQueryFilters":{"type":"object","required":["criteria","name"],"properties":{"name":{"type":"string","example":"customFields","description":"Name of the attribute to filter.","enum":["customFields"]},"operator":{"type":"string","description":"Query filter logical operator to join criteria.","enum":["AND","OR"]},"criteria":{"type":"array","description":"Query filter criteria.","items":{"$ref":"#/definitions/WorkitemQueryJobQueryFiltersCriteria"},"maxItems":5,"minItems":1}}},"WorkitemQueryJobQueryFiltersCriteria":{"type":"object","required":["predicates"],"properties":{"operator":{"type":"string","description":"Query filter logical operator to join predicates.","enum":["AND","OR"]},"predicates":{"type":"array","description":"Query filter predicate.","items":{"$ref":"#/definitions/WorkitemQueryJobQueryFiltersPredicate"},"maxItems":3,"minItems":1}}},"WorkitemQueryJobQueryFiltersPredicate":{"type":"object","required":["name","operator"],"properties":{"name":{"type":"string","description":"Property name."},"operator":{"type":"string","description":"Query filter predicate operator.","enum":["EQ","NEQ","GT","LT","GTE","LTE","IN","CONTAINS","BETWEEN","BEGINS_WITH","EXISTS"]},"values":{"type":"array","description":"List of values to be used in the query filter predicate.","items":{"type":"object"}}}},"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"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"pageCount":{"type":"integer","format":"int32"}}},"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 512 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"},"autoTerminateWorkitem":{"type":"boolean","description":"Terminate workitem on selection of status. Applicable only for statuses in the Closed category."},"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 512 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"}}},"WorkitemFlowReference":{"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}}},"WorkitemRuleSettings":{"type":"object","properties":{"flowRulesEnabled":{"type":"boolean","description":"When set to true, the worktypes flow rules will be processed. Default value is false."}}},"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."},"ruleSettings":{"description":"Settings for the worktypes rules.","$ref":"#/definitions/WorkitemRuleSettings"},"flow":{"description":"The flow associated with the Worktype.","$ref":"#/definitions/WorkitemFlowReference"},"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 512 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},"ruleSettings":{"description":"Settings for the worktypes rules.","$ref":"#/definitions/WorkitemRuleSettings"},"description":{"type":"string","description":"The description of the Worktype. Maximum length of 512 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. 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},"ruleSettings":{"description":"Settings for the worktypes rules.","$ref":"#/definitions/WorkitemRuleSettings"},"description":{"type":"string","description":"The description of the Worktype. Maximum length of 512 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"}}}},"WorkitemOnAttributeChangeCondition":{"type":"object","required":["attribute","newValue"],"properties":{"attribute":{"type":"string","description":"The name of the workitem attribute whose change will be evaluated as part of the rule.","enum":["statusId"]},"newValue":{"type":"string","description":"The new value of the attribute. If the attribute is updated to this value this part of the condition will be met."},"oldValue":{"type":"string","description":"The old value of the attribute. If the attribute was updated from this value this part of the condition will be met."}}},"WorkitemOnAttributeChangeRule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"The type of the rule.","enum":["OnCreate","OnAttributeChange","Date"]},"action":{"description":"The rules action. If the condition criteria is met this action will be executed.","$ref":"#/definitions/WorkitemRuleAction"},"worktype":{"description":"The Worktype containing the rule.","$ref":"#/definitions/WorktypeReference"},"condition":{"description":"The rules condition. If the condition criteria is met the rules action will be executed.","$ref":"#/definitions/WorkitemOnAttributeChangeCondition"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemOnAttributeChangeConditionUpdate":{"type":"object","required":["attribute","newValue"],"properties":{"attribute":{"type":"string","description":"The name of the workitem attribute whose change will be evaluated as part of the rule.","enum":["statusId"]},"newValue":{"type":"string","description":"The new value of the attribute. If the attribute is updated to this value this part of the condition will be met."},"oldValue":{"type":"string","description":"The old value of the attribute. If the attribute was updated from this value this part of the condition will be met."}}},"WorkitemOnAttributeChangeRuleUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the rule."},"condition":{"description":"The rules condition. If the condition criteria is met the rules action will be executed.","$ref":"#/definitions/WorkitemOnAttributeChangeConditionUpdate"}}},"WorkitemOnAttributeChangeRuleCreate":{"type":"object","required":["condition","name"],"properties":{"name":{"type":"string","description":"The name of the rule."},"condition":{"description":"The rules condition. If the condition criteria is met the rules action will be executed.","$ref":"#/definitions/WorkitemOnAttributeChangeCondition"}}},"WorkitemOnAttributeChangeRuleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemOnAttributeChangeRule"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"WorkitemOnCreateRule":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"name":{"type":"string"},"type":{"type":"string","description":"The type of the rule.","enum":["OnCreate","OnAttributeChange","Date"]},"action":{"description":"The rules action. If the condition criteria is met this action will be executed.","$ref":"#/definitions/WorkitemRuleAction"},"worktype":{"description":"The Worktype containing the rule.","$ref":"#/definitions/WorktypeReference"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"WorkitemOnCreateRuleUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the rule."}}},"WorkitemOnCreateRuleCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the rule."}}},"WorkitemOnCreateRuleListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/WorkitemOnCreateRule"}},"nextUri":{"type":"string"},"selfUri":{"type":"string"},"previousUri":{"type":"string"},"after":{"type":"string"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"]}}},"CoachingAppointmentStatusRequest":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"The status of the coaching appointment","enum":["Scheduled","InProgress","Completed"]}}},"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"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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","Native"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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 (deprecated), AssessedContent (deprecated), Assessment (deprecated), Coaching, External, Native"}}},"CelebrationStateParam":{"type":"object","properties":{"state":{"type":"string","description":"The state of the celebration","enum":["Displayed"]}}},"Celebration":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"recipient":{"description":"The Recipient of the celebration","$ref":"#/definitions/UserReference"},"createdBy":{"description":"The creator of the celebration","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The date the celebration was created on. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The Celebration Type","enum":["Recognition"]},"title":{"type":"string","description":"The Celebration title"},"note":{"type":"string","description":"The Celebration note"},"sourceEntity":{"description":"The celebration's source entity","$ref":"#/definitions/SourceEntity"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"GetCelebrationListing":{"type":"object","properties":{"entities":{"type":"array","items":{"$ref":"#/definitions/Celebration"}},"pageSize":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"SourceEntity":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"type":{"type":"string","description":"The type of the source entity","enum":["ThankYou","Congratulations","HighPerformance","CompanyValues"]},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"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 (deprecated), AssessedContent (deprecated), Assessment (deprecated), External, Native"}}},"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}}},"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"}}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"type":"string","format":"uri"},"pageCount":{"type":"integer","format":"int32"}}},"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","Native"]},"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"}}},"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"}}},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"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. Informational, AssessedContent and Assessment are deprecated","enum":["Informational","AssessedContent","Assessment","External","Native"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"},"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"},"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","Native"]},"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"},"firstUri":{"type":"string","format":"uri"},"lastUri":{"type":"string","format":"uri"},"selfUri":{"type":"string","format":"uri"},"nextUri":{"type":"string","format":"uri"},"previousUri":{"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"}}},"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"},"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"},"name":{"type":"string","description":"The name of this SCO in the course manifest"},"successStatus":{"type":"string","description":"The success status of this SCO","enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of this SCO","enum":["Completed","Incomplete","NotAttempted","Unknown"]},"percentageScore":{"type":"number","format":"float","description":"Percentage Score"},"children":{"type":"array","description":"Child items belonging to this SCO in the course manifest","items":{"$ref":"#/definitions/LearningModulePreviewUpdateScoStructure"}}},"description":"Learning module preview update SCO structure"},"LearningModulePreviewUpdateStep":{"type":"object","properties":{"id":{"type":"string","description":"The id of the step"},"successStatus":{"type":"string","description":"The success status of the step","enum":["Passed","Failed","Unknown"]},"completionStatus":{"type":"string","description":"The completion status of the step","enum":["Completed","Incomplete","NotAttempted","Unknown"]},"completionPercentage":{"type":"number","format":"float","description":"The completion percentage of the step"},"percentageScore":{"type":"number","format":"float","description":"Percentage Score"},"structure":{"type":"array","description":"The structure for any SCO associated with this step","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"},"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"},"Recognition":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"recipient":{"description":"The recipient of the recognition","$ref":"#/definitions/UserReference"},"createdBy":{"description":"The creator of the recognition","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The creation date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The type of recognition","enum":["ThankYou","Congratulations","HighPerformance","CompanyValues"]},"title":{"type":"string","description":"The recognition title"},"note":{"type":"string","description":"The recognition note"},"contextType":{"type":"string","description":"The context type (optional)","enum":["Interaction","Insights","Development","Scorecard"]},"contextId":{"type":"string","description":"The context id (optional)"},"dateDisplayed":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The displayed date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"dateAcknowledged":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The acknowledged date. 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}}},"RecognitionBase":{"type":"object","properties":{"id":{"type":"string","description":"The globally unique identifier for the object.","readOnly":true},"recipient":{"description":"The recipient of the recognition","$ref":"#/definitions/UserReference"},"createdBy":{"description":"The creator of the recognition","$ref":"#/definitions/UserReference"},"dateCreated":{"type":"string","format":"date-time","example":"2023-01-01T01:01:01Z","description":"The creation date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"},"type":{"type":"string","description":"The type of recognition","enum":["ThankYou","Congratulations","HighPerformance","CompanyValues"]},"title":{"type":"string","description":"The recognition title"},"note":{"type":"string","description":"The recognition note"},"contextType":{"type":"string","description":"The context type (optional)","enum":["Interaction","Insights","Development","Scorecard"]},"contextId":{"type":"string","description":"The context id (optional)"},"selfUri":{"type":"string","format":"uri","description":"The URI for this object","readOnly":true}}},"CreateRecognition":{"type":"object","required":["recipientId","type"],"properties":{"recipientId":{"type":"string","description":"The recipient of the recognition"},"type":{"type":"string","description":"The type of the recognition","enum":["ThankYou","Congratulations","HighPerformance","CompanyValues"]},"title":{"type":"string","description":"The title of the recognition. Max length of 100 characters (optional)"},"note":{"type":"string","description":"The note of the recognition. Max length of 800 characters (optional)"},"contextType":{"type":"string","description":"The context type (optional)","enum":["Interaction","Insights","Development","Scorecard"]},"contextId":{"type":"string","description":"The context id (optional)"}}}},"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"}},"409":{"description":"The request conflicts with the current state of the target resource.","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 8bd060bdd..307399f88 100644 --- a/version.json +++ b/version.json @@ -1,9 +1,9 @@ { - "major": 157, + "major": 158, "minor": 0, "point": 0, "prerelease": "", "apiVersion": 0, - "display": "157.0.0", - "displayFull": "157.0.0" + "display": "158.0.0", + "displayFull": "158.0.0" } \ No newline at end of file